Package org.forgerock.openam.utils

Interface OpenAMSettings

All Known Implementing Classes:

OpenAMSettingsImpl, UmaSettingsImpl

public interface OpenAMSettings

Provides access to any OpenAM settings.

Since:

12.0.0

Method Summary

Modifier and Type	Method	Description
Boolean	getBooleanSetting(String realm, String attributeName)	Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value and parses it to a Boolean.
Long	getLongSetting(String realm, String attributeName)	Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value and decodes it to a Long.
Map<String,String>	getMapSetting(String realm, String attributeName)	Gets a setting from the given realm and parses it as into a Map from string keys to string values, according to the MapValueParser format.
KeyPair	getServerKeyPair(String realm, String attributeName)	Gets the key pair that OpenAM is configured to use for the specified realm.
Set<String>	getSetting(String realm, String attributeName)	Gets the raw Set of the values of the specified attribute name in the given realm.
KeyPair	getSigningKeyPair(String realm, org.forgerock.json.jose.jws.JwsAlgorithm algorithm)	Gets the key pair that OpenAM is configured to use for the specified realm.
String	getSSOCookieName()	Gets the name of the SSO Cookie.
String	getStringSetting(String realm, String attributeName)	Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value.
boolean	hasConfig(String realm)	Whether there is realm config for the service

Method Detail

getSetting

Set<String> getSetting(String realm,
                       String attributeName)
                throws SSOException,
                       SMSException

Gets the raw Set of the values of the specified attribute name in the given realm.

Parameters:

realm - The realm.

attributeName - The attribute name,.

Returns:

The Set of values.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getStringSetting

String getStringSetting(String realm,
                        String attributeName)
                 throws SSOException,
                        SMSException

Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value.

Parameters:

realm - The realm.

attributeName - The attribute name,.

Returns:

The Set of values.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getLongSetting

Long getLongSetting(String realm,
                    String attributeName)
             throws SSOException,
                    SMSException

Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value and decodes it to a Long.

Parameters:

realm - The realm.

attributeName - The attribute name,.

Returns:

The Set of values.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getBooleanSetting

Boolean getBooleanSetting(String realm,
                          String attributeName)
                   throws SSOException,
                          SMSException

Gets the raw Set of the values of the specified attribute name in the given realm and gets the first value and parses it to a Boolean.

Parameters:

realm - The realm.

attributeName - The attribute name,.

Returns:

The Set of values.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getMapSetting

Map<String,String> getMapSetting(String realm,
                                       String attributeName)
                                throws SSOException,
                                       SMSException

Gets a setting from the given realm and parses it as into a Map from string keys to string values, according to the MapValueParser format.

Parameters:

realm - the realm.

attributeName - the attribute name.

Returns:

The Map of values parsed from the attribute.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getSigningKeyPair

KeyPair getSigningKeyPair(String realm,
                          org.forgerock.json.jose.jws.JwsAlgorithm algorithm)
                   throws SMSException,
                          SSOException

Gets the key pair that OpenAM is configured to use for the specified realm.

Parameters:

realm - The realm.

algorithm - The signing algorithm.

Returns:

The key pair.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getServerKeyPair

KeyPair getServerKeyPair(String realm,
                         String attributeName)
                  throws SMSException,
                         SSOException

Gets the key pair that OpenAM is configured to use for the specified realm.

Parameters:

realm - The realm.

attributeName - The attribute name the alias for the key pair is stored.

Returns:

The key pair.

Throws:

SSOException - If there is a problem getting the setting value.

SMSException - If there is a problem getting the setting value.

getSSOCookieName

String getSSOCookieName()

Gets the name of the SSO Cookie.

Returns:

The SSO Cookie name.

hasConfig

boolean hasConfig(String realm)
           throws SSOException,
                  SMSException

Whether there is realm config for the service

Throws:

SSOException

SMSException