org.forgerock.openam.selfservice.config.beans

Class ForgottenUsernameConsoleConfig

java.lang.Object

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

All Implemented Interfaces:

SelfServiceConsoleConfig

public final class ForgottenUsernameConsoleConfig
extends Object

Represents forgotten username console configuration.

Since:

13.0.0

Method Summary

Modifier and Type	Method and 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	getConfigProviderClass()
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<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

getAttributeAsString

public final String getAttributeAsString(String key)

Retrieves the underlying console attribute for the key.

Parameters:

key - console attribute key

Returns:

corresponding string value

getAttributeAsSet

public final Set<String> getAttributeAsSet(String key)

Retrieves the underlying console attribute for the key.

Parameters:

key - console attribute key

Returns:

corresponding set value