Class UserRegistration
- java.lang.Object
-
- com.broadleafcommerce.auth.user.api.dto.UserRegistration
-
public class UserRegistration extends Object
Representation of a registration from the frontend- Author:
- Phillip Verheyden (phillipuniverse)
-
-
Constructor Summary
Constructors Constructor Description UserRegistration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
Map<String,Object>
getAttributes()
Client implementations may choose to utilize this field to accept and pass additional custom information as part of the user registration process.String
getClientId()
The application's client_id that this user is registering toString
getEmail()
Email addressString
getFullName()
Full name of the userString
getPassword()
String
getPasswordConfirmation()
Must match the givenpassword
Boolean
getPreview()
True if this registration is in a preview contextString
getReturnTo()
The location to which the user is forwarded after registrationString
getUsername()
UsernameString
getUserType()
The type of user to register this user as.int
hashCode()
void
setAttributes(Map<String,Object> attributes)
Client implementations may choose to utilize this field to accept and pass additional custom information as part of the user registration process.void
setClientId(String clientId)
The application's client_id that this user is registering tovoid
setEmail(String email)
Email addressvoid
setFullName(String fullName)
Full name of the uservoid
setPassword(String password)
void
setPasswordConfirmation(String passwordConfirmation)
Must match the givenpassword
void
setPreview(Boolean preview)
True if this registration is in a preview contextvoid
setReturnTo(String returnTo)
The location to which the user is forwarded after registrationvoid
setUsername(String username)
Usernamevoid
setUserType(String userType)
The type of user to register this user as.String
toString()
-
-
-
Method Detail
-
getUserType
public String getUserType()
The type of user to register this user as.- See Also:
UserType
-
getFullName
public String getFullName()
Full name of the user
-
getUsername
public String getUsername()
UsernameOnly used when
AuthRegistrationProperties.isEmailAsUsername()
is disabled
-
getEmail
public String getEmail()
Email address
-
getPassword
public String getPassword()
- See Also:
PasswordRequestValidator
-
getPasswordConfirmation
public String getPasswordConfirmation()
Must match the givenpassword
- See Also:
PasswordRequestValidator
-
getClientId
public String getClientId()
The application's client_id that this user is registering to
-
getReturnTo
public String getReturnTo()
The location to which the user is forwarded after registration
-
getPreview
public Boolean getPreview()
True if this registration is in a preview context
-
getAttributes
public Map<String,Object> getAttributes()
Client implementations may choose to utilize this field to accept and pass additional custom information as part of the user registration process. By default, these attributes are passed to other interested microservices viaUserCreationEvent.attributes
.- See Also:
UserCreationEvent.attributes
-
setUserType
public void setUserType(String userType)
The type of user to register this user as.- See Also:
UserType
-
setFullName
public void setFullName(String fullName)
Full name of the user
-
setUsername
public void setUsername(String username)
UsernameOnly used when
AuthRegistrationProperties.isEmailAsUsername()
is disabled
-
setEmail
public void setEmail(String email)
Email address
-
setPassword
public void setPassword(String password)
- See Also:
PasswordRequestValidator
-
setPasswordConfirmation
public void setPasswordConfirmation(String passwordConfirmation)
Must match the givenpassword
- See Also:
PasswordRequestValidator
-
setClientId
public void setClientId(String clientId)
The application's client_id that this user is registering to
-
setReturnTo
public void setReturnTo(String returnTo)
The location to which the user is forwarded after registration
-
setPreview
public void setPreview(Boolean preview)
True if this registration is in a preview context
-
setAttributes
public void setAttributes(Map<String,Object> attributes)
Client implementations may choose to utilize this field to accept and pass additional custom information as part of the user registration process. By default, these attributes are passed to other interested microservices viaUserCreationEvent.attributes
.- See Also:
UserCreationEvent.attributes
-
canEqual
protected boolean canEqual(Object other)
-
-