org.forgerock.openam.selfservice.config.beans

Class UserRegistrationConsoleConfig

java.lang.Object

org.forgerock.openam.selfservice.config.beans.UserRegistrationConsoleConfig

All Implemented Interfaces:

SelfServiceConsoleConfig

public final class UserRegistrationConsoleConfig
extends Object

Represents user registration 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()
String	getEmailVerificationUrl(String realm) Gets the verification Url to be sent with the email body.
Map<Locale,String>	getMessageTranslations() Gets the map of locales to email body text strings.
int	getMinimumAnswersToDefine() Get the minimum count of answers to define.
Map<Locale,String>	getSubjectTranslations() Gets the map of locales to subject strings.
long	getTokenExpiry() Gets the token expiry time in seconds.
RegistrationDestination	getUserRegistrationDestination() Gets the user registration destination.
boolean	isCaptchaEnabled() Whether the captcha stage is enabled.
boolean	isEmailEnabled() Whether email verification is enabled.
boolean	isEmailVerificationFirstEnabled() Whether email verification before user detail option is enabled.
boolean	isEnabled() Whether the service is enabled.
boolean	isKbaEnabled() Whether the KBA stage is enabled.

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

isEmailVerificationFirstEnabled

public boolean isEmailVerificationFirstEnabled()

Whether email verification before user detail option is enabled.

Returns:

whether email verification before user detail option 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.

getEmailVerificationUrl

public String getEmailVerificationUrl(String realm)

Gets the verification Url to be sent with the email body.

Parameters:

realm - the absolute realm

Returns:

email verification Url

getMinimumAnswersToDefine

public int getMinimumAnswersToDefine()

Get the minimum count of answers to define.

Returns:

minimum count

getUserRegistrationDestination

public RegistrationDestination getUserRegistrationDestination()

Gets the user registration destination.

Returns:

user registration destination

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