RegisterController (Grails 8.0.0-SNAPSHOT)

grails.plugin.springsecurity.ui.RegisterController

All Implemented Interfaces and Traits:: GrailsConfigurationAware

class RegisterController
extends AbstractS2UiController
implements GrailsConfigurationAware

Authors:: Burt Beckwith

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.String`	`forgotPasswordEmailBody`
`protected java.util.List<java.util.HashMap>`	`forgotPasswordExtraValidation`
`protected java.lang.String`	`forgotPasswordExtraValidationDomainClassName`
`protected static int`	`passwordMaxLength`
`protected static int`	`passwordMinLength`
`protected static java.lang.String`	`passwordValidationRegex`
`protected java.lang.String`	`registerEmailBody`
`protected java.lang.String`	`registerEmailFrom`
`protected java.lang.String`	`registerEmailSubject`
`protected java.lang.String`	`registerPostRegisterUrl`
`protected java.lang.String`	`registerPostResetUrl`
`protected java.lang.Boolean`	`requireEmailValidation`
`protected java.lang.Boolean`	`requireForgotPassEmailValidation`
`protected java.lang.String`	`successHandlerDefaultTargetUrl`
`protected java.lang.String`	`validationUserLookUpProperty`

Inherited fields
Fields inherited from class	Fields
`class AbstractS2UiController`	`Role, User, UserRole, authorityNameField, usernamePropertyName`

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`EMAIL_LAYOUT`
`static java.lang.String`	`FORGOT_PASSWORD_TEMPLATE`
`static java.lang.String`	`VERIFY_REGISTRATION_TEMPLATE`
`static java.lang.Object`	`defaultAction`
`PageRenderer`	`groovyPageRenderer`
`MessageSource`	`messageSource`
`static java.lang.Object`	`password2Validator`
`static java.lang.Object`	`passwordValidator`
`java.lang.String`	`serverURL`
`MailStrategy`	`uiMailStrategy` Dependency injection for the 'uiMailStrategy' bean.
`PropertiesStrategy`	`uiPropertiesStrategy` Dependency injection for the 'uiPropertiesStrategy' bean.
`RegistrationCodeStrategy`	`uiRegistrationCodeStrategy` Dependency injection for the 'uiRegistrationCodeStrategy' bean.

Inherited properties
Properties inherited from class	Properties
`class AbstractS2UiController`	`scope`

Constructor Summary

Constructors
Constructor and description
`RegisterController()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`afterPropertiesSet()`
	`static boolean`	`checkPasswordMaxLength(java.lang.String password, java.lang.Object command)`
	`static boolean`	`checkPasswordMinLength(java.lang.String password, java.lang.Object command)`
	`static boolean`	`checkPasswordRegex(java.lang.String password, java.lang.Object command)`
	`protected java.lang.String`	`evaluate(java.lang.Object s, java.lang.Object binding)`
	`java.lang.Object`	`forgotPassword(ForgotPasswordCommand forgotPasswordCommand)`
	`protected java.lang.String`	`generateLink(java.lang.String action, java.util.Map linkParams, boolean shouldUseServerUrl)` Creates a grails application link from a set of attributes.
	`protected java.lang.Object`	`processForgotPasswordEmail(java.lang.Object forgotPasswordCommand, java.lang.Object user)`
	`protected void`	`redirectVerifyRegistration(java.lang.Object rtn)`
	`java.lang.Object`	`register(RegisterCommand registerCommand)`
	`protected java.lang.String`	`renderRegistrationMailBody(java.lang.String url, java.lang.Object user)` Render the email body using text from DefaultUiSecurityConfig if it exists.
	`java.lang.Object`	`resetPassword(ResetPasswordCommand resetPasswordCommand)`
	`java.lang.Object`	`securityQuestions()`
	`protected void`	`sendVerifyRegistrationMail(RegistrationCode registrationCode, java.lang.Object user, java.lang.String email)`
	`void`	`setConfiguration(Config co)`
	`java.lang.Object`	`verifyRegistration()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractS2UiController`	`afterPropertiesSet, findUserByUsername, getConf, getDomainClassClass`

- Field Detail
  - protected java.lang.String forgotPasswordEmailBody
  - protected java.util.List<java.util.HashMap> forgotPasswordExtraValidation
  - protected java.lang.String forgotPasswordExtraValidationDomainClassName
  - protected static int passwordMaxLength
  - protected static int passwordMinLength
  - protected static java.lang.String passwordValidationRegex
  - protected java.lang.String registerEmailBody
  - protected java.lang.String registerEmailFrom
  - protected java.lang.String registerEmailSubject
  - protected java.lang.String registerPostRegisterUrl
  - protected java.lang.String registerPostResetUrl
  - protected java.lang.Boolean requireEmailValidation
  - protected java.lang.Boolean requireForgotPassEmailValidation
  - protected java.lang.String successHandlerDefaultTargetUrl
  - protected java.lang.String validationUserLookUpProperty
- Property Detail
  - static final java.lang.String EMAIL_LAYOUT
  - static final java.lang.String FORGOT_PASSWORD_TEMPLATE
  - static final java.lang.String VERIFY_REGISTRATION_TEMPLATE
  - static java.lang.Object defaultAction
  - PageRenderer groovyPageRenderer
  - MessageSource messageSource
  - static final java.lang.Object password2Validator
  - static final java.lang.Object passwordValidator
  - java.lang.String serverURL
  - MailStrategy uiMailStrategy
    
    Dependency injection for the 'uiMailStrategy' bean.
  - PropertiesStrategy uiPropertiesStrategy
    
    Dependency injection for the 'uiPropertiesStrategy' bean.
  - RegistrationCodeStrategy uiRegistrationCodeStrategy
    
    Dependency injection for the 'uiRegistrationCodeStrategy' bean.
- Constructor Detail
  - RegisterController()
- Method Detail
  - void afterPropertiesSet()
  - static boolean checkPasswordMaxLength(java.lang.String password, java.lang.Object command)
  - static boolean checkPasswordMinLength(java.lang.String password, java.lang.Object command)
  - static boolean checkPasswordRegex(java.lang.String password, java.lang.Object command)
  - protected java.lang.String evaluate(java.lang.Object s, java.lang.Object binding)
  - java.lang.Object forgotPassword(ForgotPasswordCommand forgotPasswordCommand)
  - protected java.lang.String generateLink(java.lang.String action, java.util.Map linkParams, boolean shouldUseServerUrl)
    
    Creates a grails application link from a set of attributes.
    Parameters:
    action
    linkParams
    shouldUseServerUrl - (optional) - If true, will utilize the configured grails.serverURL from application.yml if it exists otherwise the base url will be constructed the same as it always has been
    Returns:
    String representing the relative or absolute URL
  - protected java.lang.Object processForgotPasswordEmail(java.lang.Object forgotPasswordCommand, java.lang.Object user)
  - protected void redirectVerifyRegistration(java.lang.Object rtn)
  - java.lang.Object register(RegisterCommand registerCommand)
  - protected java.lang.String renderRegistrationMailBody(java.lang.String url, java.lang.Object user)
    
    Render the email body using text from DefaultUiSecurityConfig if it exists. If not, render using gsps
    Parameters:
    url
    user
    Returns:
    html mail goodness
  - java.lang.Object resetPassword(ResetPasswordCommand resetPasswordCommand)
  - java.lang.Object securityQuestions()
  - protected void sendVerifyRegistrationMail(RegistrationCode registrationCode, java.lang.Object user, java.lang.String email)
  - @java.lang.Override
    void setConfiguration(Config co)
  - java.lang.Object verifyRegistration()

Summary:
Field
Property
Constructor
Method

[Groovy] Class RegisterController

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.String forgotPasswordEmailBody

protected java.util.List<java.util.HashMap> forgotPasswordExtraValidation

protected java.lang.String forgotPasswordExtraValidationDomainClassName

protected static int passwordMaxLength

protected static int passwordMinLength

protected static java.lang.String passwordValidationRegex

protected java.lang.String registerEmailBody

protected java.lang.String registerEmailFrom

protected java.lang.String registerEmailSubject

protected java.lang.String registerPostRegisterUrl

protected java.lang.String registerPostResetUrl

protected java.lang.Boolean requireEmailValidation

protected java.lang.Boolean requireForgotPassEmailValidation

protected java.lang.String successHandlerDefaultTargetUrl

protected java.lang.String validationUserLookUpProperty

Property Detail

static final java.lang.String EMAIL_LAYOUT

static final java.lang.String FORGOT_PASSWORD_TEMPLATE

static final java.lang.String VERIFY_REGISTRATION_TEMPLATE

static java.lang.Object defaultAction

PageRenderer groovyPageRenderer

MessageSource messageSource

static final java.lang.Object password2Validator

static final java.lang.Object passwordValidator

java.lang.String serverURL

MailStrategy uiMailStrategy

PropertiesStrategy uiPropertiesStrategy

RegistrationCodeStrategy uiRegistrationCodeStrategy

Constructor Detail

RegisterController()

Method Detail

void afterPropertiesSet()

static boolean checkPasswordMaxLength(java.lang.String password, java.lang.Object command)

static boolean checkPasswordMinLength(java.lang.String password, java.lang.Object command)

static boolean checkPasswordRegex(java.lang.String password, java.lang.Object command)

protected java.lang.String evaluate(java.lang.Object s, java.lang.Object binding)

java.lang.Object forgotPassword(ForgotPasswordCommand forgotPasswordCommand)

protected java.lang.String generateLink(java.lang.String action, java.util.Map linkParams, boolean shouldUseServerUrl)

protected java.lang.Object processForgotPasswordEmail(java.lang.Object forgotPasswordCommand, java.lang.Object user)

protected void redirectVerifyRegistration(java.lang.Object rtn)

java.lang.Object register(RegisterCommand registerCommand)

protected java.lang.String renderRegistrationMailBody(java.lang.String url, java.lang.Object user)

java.lang.Object resetPassword(ResetPasswordCommand resetPasswordCommand)

java.lang.Object securityQuestions()

protected void sendVerifyRegistrationMail(RegistrationCode registrationCode, java.lang.Object user, java.lang.String email)

@java.lang.Overridevoid setConfiguration(Config co)

java.lang.Object verifyRegistration()

@java.lang.Override
void setConfiguration(Config co)