java.lang.Object
- org.forgerock.openam.selfservice.config.beans.UserRegistrationConsoleConfig.UserRegistrationBuilder

All Implemented Interfaces:

org.forgerock.openam.sm.config.ConsoleConfigBuilder<UserRegistrationConsoleConfig>

Enclosing class:

UserRegistrationConsoleConfig
```
@ConfigSource({"MailServer","selfService"})
public static final class UserRegistrationConsoleConfig.UserRegistrationBuilder
extends Object
```
Builder for UserRegistrationConsoleConfig.

Constructor Summary

Constructors
Constructor Description

UserRegistrationBuilder()
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`	`setEmailVerificationFirstEnabled(boolean emailVerificationFirstEnabled)`	Sets whether email verification before user detail option 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`	`setMinimumAnswersToDefine(int minimumAnswersToDefine)`	Sets the minimum number of answers to be defined.
`void`	`setSubjectTranslations(Map<Locale,String> subjectTranslations)`	Sets the email subject translations.
`void`	`setTokenExpiry(long tokenExpiry)`	Sets the token expiry time.
`void`	`setUserRegistrationDestination(org.forgerock.openam.selfservice.config.beans.RegistrationDestination userRegistrationDestination)`	Sets the user registration destination.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- UserRegistrationBuilder
```
public UserRegistrationBuilder()
```
  Constructs a new builder.

Method Detail

setEnabled

@ConfigAttribute("selfServiceUserRegistrationEnabled")
public void setEnabled(boolean enabled)

Sets whether the service is enabled.

Parameters:: enabled - whether the service is enabled

setConfigProviderClass

@ConfigAttribute("selfServiceUserRegistrationServiceConfigClass")
public void setConfigProviderClass(String configProviderClass)

Sets the config provider class.

Parameters:: configProviderClass - config provider class

setTokenExpiry

@ConfigAttribute("selfServiceUserRegistrationTokenTTL")
public void setTokenExpiry(long tokenExpiry)

Sets the token expiry time.

Parameters:: tokenExpiry - token expiry time

setEmailEnabled

@ConfigAttribute("selfServiceUserRegistrationEmailVerificationEnabled")
public void setEmailEnabled(boolean emailEnabled)

Sets whether email is enabled.

Parameters:: emailEnabled - whether email is enabled

setEmailVerificationFirstEnabled
```
@ConfigAttribute("selfServiceUserRegistrationEmailVerificationFirstEnabled")
public void setEmailVerificationFirstEnabled(boolean emailVerificationFirstEnabled)
```
Sets whether email verification before user detail option is enabled.

Parameters:

emailVerificationFirstEnabled - whether email verification before user detail option is enabled

setSubjectTranslations

@ConfigAttribute(value="selfServiceUserRegistrationEmailSubject",
                 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="selfServiceUserRegistrationEmailBody",
                 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("selfServiceUserRegistrationCaptchaEnabled")
public void setCaptchaEnabled(boolean captchaEnabled)

Sets whether captcha is enabled.

Parameters:: captchaEnabled - whether captcha is enabled

setKbaEnabled

@ConfigAttribute("selfServiceUserRegistrationKbaEnabled")
public void setKbaEnabled(boolean kbaEnabled)

Sets whether KBA is enabled.

Parameters:: kbaEnabled - whether KBA is enabled

setEmailVerificationUrl

@ConfigAttribute("selfServiceUserRegistrationConfirmationUrl")
public void setEmailVerificationUrl(String emailVerificationUrl)

Sets the email verification URL.

Parameters:: emailVerificationUrl - email verification URL

setMinimumAnswersToDefine
```
@ConfigAttribute("selfServiceMinimumAnswersToDefine")
public void setMinimumAnswersToDefine(int minimumAnswersToDefine)
```
Sets the minimum number of answers to be defined.

Parameters:

minimumAnswersToDefine - minimum number of answers to be defined

setUserRegistrationDestination

@ConfigAttribute(value="selfServiceUserRegistrationDestination",
                 transformer=org.forgerock.openam.selfservice.config.beans.DestinationTransformer.class)
public void setUserRegistrationDestination(org.forgerock.openam.selfservice.config.beans.RegistrationDestination userRegistrationDestination)

Sets the user registration destination.

Parameters:: userRegistrationDestination - user registration destination

Class UserRegistrationConsoleConfig.UserRegistrationBuilder

Constructor Summary