Package org.forgerock.openam.selfservice.config.beans

Class ForgottenUsernameConsoleConfig

java.lang.Object

org.forgerock.openam.selfservice.config.beans.ForgottenUsernameConsoleConfig

All Implemented Interfaces:

SelfServiceConsoleConfig

@SupportedAll
public final class ForgottenUsernameConsoleConfig
extends Object

Represents forgotten username console configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForgottenUsernameConsoleConfig.ForgottenUsernameBuilder	Builder for ForgottenUsernameConsoleConfig.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAttributeAsSet(String key)	Retrieves the underlying console attribute for the key.
String	getAttributeAsString(String key)	Retrieves the underlying console attribute for the key.
String	getCaptchaSecretKey()	Gets the captcha secret key.
String	getCaptchaSiteKey()	Gets the captcha site key.
String	getCaptchaVerificationUrl()	Gets the captcha verification URL.
String	getConfigProviderClass()
String	getEmailAttributeName()	Gets the email attribute name.
String	getEncryptionKeyPairAlias()	Gets the encryption key pair alias.
Map<Locale,String>	getMessageTranslations()	Gets the map of locales to email body text strings.
int	getMinimumAnswersToVerify()	Get the minimum count of questions to verify.
Map<String,Map<String,String>>	getSecurityQuestions()	Gets the security questions.
String	getSigningSecretKeyAlias()	Gets the signing secret key alias.
Map<Locale,String>	getSubjectTranslations()	Gets the map of locales to subject strings.
long	getTokenExpiry()	Gets the token expiry time in seconds.
Set<String>	getValidQueryAttributes()	Get set of valid query attributes.
boolean	isCaptchaEnabled()	Whether the captcha stage is enabled.
boolean	isEmailEnabled()	Whether email verification is enabled.
boolean	isEnabled()	Whether the service is enabled.
boolean	isKbaEnabled()	Whether the KBA stage is enabled.
boolean	isShowUsernameEnabled()	Whether or the not the username should be displayed.

Methods inherited from class java.lang.Object

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

Method Detail

getConfigProviderClass

public String getConfigProviderClass()

isEnabled

public boolean isEnabled()

Whether the service is enabled.

Returns:

whether the service is enabled

isEmailEnabled

public boolean isEmailEnabled()

Whether email verification is enabled.

Returns:

whether email verification is enabled

getTokenExpiry

public long getTokenExpiry()

Gets the token expiry time in seconds.

Returns:

the token expiry time

isCaptchaEnabled

public boolean isCaptchaEnabled()

Whether the captcha stage is enabled.

Returns:

whether the captcha stage is enabled

isKbaEnabled

public boolean isKbaEnabled()

Whether the KBA stage is enabled.

Returns:

whether the KBA stage is enabled

getSubjectTranslations

public Map<Locale,String> getSubjectTranslations()

Gets the map of locales to subject strings.

Returns:

the map of locales to subject text strings.

getMessageTranslations

public Map<Locale,String> getMessageTranslations()

Gets the map of locales to email body text strings.

Returns:

the map of locales to email body text strings.

getMinimumAnswersToVerify

public int getMinimumAnswersToVerify()

Get the minimum count of questions to verify.

Returns:

minimum count

isShowUsernameEnabled

public boolean isShowUsernameEnabled()

Whether or the not the username should be displayed.

Returns:

whether username should be shown

getValidQueryAttributes

public Set<String> getValidQueryAttributes()

Get set of valid query attributes.

Returns:

valid query attributes

getEncryptionKeyPairAlias

public final String getEncryptionKeyPairAlias()

Gets the encryption key pair alias.

Returns:

the encryption key pair alias

getSigningSecretKeyAlias

public final String getSigningSecretKeyAlias()

Gets the signing secret key alias.

Returns:

the signing secret key alias

getCaptchaSiteKey

public final String getCaptchaSiteKey()

Gets the captcha site key.

Returns:

the captcha site key

getCaptchaSecretKey

public final String getCaptchaSecretKey()

Gets the captcha secret key.

Returns:

the captcha secret key

getCaptchaVerificationUrl

public final String getCaptchaVerificationUrl()

Gets the captcha verification URL.

Returns:

the captcha verification URL

getSecurityQuestions

public final Map<String,Map<String,String>> getSecurityQuestions()

Gets the security questions. Expected format:

Map<id,Map<locale,question>>

Returns:

security questions

getEmailAttributeName

public final String getEmailAttributeName()

Gets the email attribute name.

Returns:

the email attribute name

getAttributeAsString

@Supported
public final String getAttributeAsString(String key)

Retrieves the underlying console attribute for the key.

Parameters:

key - console attribute key

Returns:

corresponding string value

getAttributeAsSet

@Supported
public final Set<String> getAttributeAsSet(String key)

Retrieves the underlying console attribute for the key.

Parameters:

key - console attribute key

Returns:

corresponding set value