Class ForgottenPasswordConsoleConfig.ForgottenPasswordBuilder
- java.lang.Object
-
- org.forgerock.openam.selfservice.config.beans.ForgottenPasswordConsoleConfig.ForgottenPasswordBuilder
-
- All Implemented Interfaces:
org.forgerock.openam.sm.config.ConsoleConfigBuilder<ForgottenPasswordConsoleConfig>
- Enclosing class:
- ForgottenPasswordConsoleConfig
@ConfigSource({"MailServer","selfService"}) public static final class ForgottenPasswordConsoleConfig.ForgottenPasswordBuilder extends Object
Builder forForgottenPasswordConsoleConfig
.
-
-
Constructor Summary
Constructors Constructor Description ForgottenPasswordBuilder()
Constructs a new builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
setCaptchaEnabled(boolean captchaEnabled)
Sets whether captcha is enabled.void
setConfigProviderClass(String configProviderClass)
Sets the config provider class.void
setEmailEnabled(boolean emailEnabled)
Sets whether email is enabled.void
setEmailVerificationUrl(String emailVerificationUrl)
Sets the email verification url.void
setEnabled(boolean enabled)
Sets whether the service is enabled.void
setKbaEnabled(boolean kbaEnabled)
Sets whether KBA is enabled.void
setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the email body translations.void
setMinimumAnswersToVerify(int minimumAnswersToVerify)
Sets the minimum number of answers to be verified.void
setNumberOfAllowedAttempts(int numberOfAllowedAttempts)
Sets the number of allowed attempts before the forgotten password feature is locked for a user.void
setNumberOfAttemptsEnforced(boolean numberOfAttemptsEnforced)
Sets whether there is a limit on the number of attempts to answer security questions when a user attempts to reset their password.void
setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the email subject translations.void
setTokenExpiry(long tokenExpiry)
Sets the token expiry time.void
setTokenStatePaddingLength(int tokenStatePaddingLength)
Sets the desired length of JWT's state claim to achieve with padding.void
setValidQueryAttributes(Set<String> validQueryAttributes)
Sets the valid set of query attributes.
-
-
-
Method Detail
-
setEmailVerificationUrl
@ConfigAttribute("selfServiceForgottenPasswordConfirmationUrl") public void setEmailVerificationUrl(String emailVerificationUrl)
Sets the email verification url.- Parameters:
emailVerificationUrl
- email verification url
-
setEnabled
@ConfigAttribute("selfServiceForgottenPasswordEnabled") public void setEnabled(boolean enabled)
Sets whether the service is enabled.- Parameters:
enabled
- whether the service is enabled
-
setConfigProviderClass
@ConfigAttribute("selfServiceForgottenPasswordServiceConfigClass") public void setConfigProviderClass(String configProviderClass)
Sets the config provider class.- Parameters:
configProviderClass
- config provider class
-
setTokenExpiry
@ConfigAttribute("selfServiceForgottenPasswordTokenTTL") public void setTokenExpiry(long tokenExpiry)
Sets the token expiry time.- Parameters:
tokenExpiry
- token expiry time
-
setTokenStatePaddingLength
@ConfigAttribute("selfServiceForgottenPasswordTokenPaddingLength") public void setTokenStatePaddingLength(int tokenStatePaddingLength)
Sets the desired length of JWT's state claim to achieve with padding.- Parameters:
tokenStatePaddingLength
- desired length of JWT's state claim after padding
-
setEmailEnabled
@ConfigAttribute("selfServiceForgottenPasswordEmailVerificationEnabled") public void setEmailEnabled(boolean emailEnabled)
Sets whether email is enabled.- Parameters:
emailEnabled
- whether email is enabled
-
setSubjectTranslations
@ConfigAttribute(value="selfServiceForgottenPasswordEmailSubject", transformer=org.forgerock.openam.selfservice.config.beans.LocaleMessageTransformer.class) public void setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the email subject translations.- Parameters:
subjectTranslations
- email subject translations
-
setMessageTranslations
@ConfigAttribute(value="selfServiceForgottenPasswordEmailBody", transformer=org.forgerock.openam.selfservice.config.beans.LocaleMessageTransformer.class) public void setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the email body translations.- Parameters:
messageTranslations
- email body translations
-
setCaptchaEnabled
@ConfigAttribute("selfServiceForgottenPasswordCaptchaEnabled") public void setCaptchaEnabled(boolean captchaEnabled)
Sets whether captcha is enabled.- Parameters:
captchaEnabled
- whether captcha is enabled
-
setKbaEnabled
@ConfigAttribute("selfServiceForgottenPasswordKbaEnabled") public void setKbaEnabled(boolean kbaEnabled)
Sets whether KBA is enabled.- Parameters:
kbaEnabled
- whether KBA is enabled
-
setMinimumAnswersToVerify
@ConfigAttribute("selfServiceMinimumAnswersToVerify") public void setMinimumAnswersToVerify(int minimumAnswersToVerify)
Sets the minimum number of answers to be verified.- Parameters:
minimumAnswersToVerify
- minimum number of answers to be verified
-
setNumberOfAttemptsEnforced
@ConfigAttribute("selfServiceNumberOfAttemptsEnforced") public void setNumberOfAttemptsEnforced(boolean numberOfAttemptsEnforced)
Sets whether there is a limit on the number of attempts to answer security questions when a user attempts to reset their password.- Parameters:
numberOfAttemptsEnforced
- whether to enable limit on attempts
-
setNumberOfAllowedAttempts
@ConfigAttribute(value="selfServiceNumberOfAllowedAttempts", required=false) public void setNumberOfAllowedAttempts(int numberOfAllowedAttempts)
Sets the number of allowed attempts before the forgotten password feature is locked for a user.- Parameters:
numberOfAllowedAttempts
- number of allowed attempts to answer kba questions.
-
-