Package com.pingidentity.sdk

Class PingFederateProperties

java.lang.Object

com.pingidentity.sdk.PingFederateProperties

public final class PingFederateProperties
extends Object

Provides an API that exposes properties of the PingFederate instance.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
static String	getAdminConsolePageTitle()	The HTML page title used for the administrator console pages.
static String	getPingOneAdminUrlEnvironmentId()	The ID of the admin's PingOne environment.
static String	getPingOneAdminUrlRegion()	The region of the admin's PingOne organization.
static boolean	getShowBackgroundImage()	The boolean to show or hide the background image on the PingFederate administrative console dashboard.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAdminConsolePageTitle

public static String getAdminConsolePageTitle()

The HTML page title used for the administrator console pages. This can be useful to change the browser tab titles when multiple instances of PingFederate are being managed.

The value can be configured in run.properties. The default is "PingFederate".

Returns:

page title to be used for admin HTML pages

Since:

7.0

getShowBackgroundImage

public static boolean getShowBackgroundImage()

The boolean to show or hide the background image on the PingFederate administrative console dashboard.

The value can be configured in run.properties. The default is true.

Returns:

the boolean value of the system property; true if one is not set.

Since:

10.1

getPingOneAdminUrlRegion

public static String getPingOneAdminUrlRegion()

The region of the admin's PingOne organization.

The value can be configured in run.properties. To prevent illegitimate links in PF, a valid value is enforced. The default is null.

Returns:

the string value of the system property; empty string if a valid one is not set.

Since:

11.0

getPingOneAdminUrlEnvironmentId

public static String getPingOneAdminUrlEnvironmentId()

The ID of the admin's PingOne environment.

The value can be configured in run.properties. The default is null.

Returns:

the string value of the system property; empty string if one is not set.

Since:

11.0