Class UserRegistration
java.lang.Object
com.broadleafcommerce.auth.user.api.dto.UserRegistration
Representation of a registration from the frontend
- Author:
- Phillip Verheyden (phillipuniverse)
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Client implementations may choose to utilize this field to accept and pass additional custom information as part of the user registration process.The application's client_id that this user is registering togetEmail()
Email addressFull name of the userMust match the givenpassword
True if this registration is in a preview contextThe location to which the user is forwarded after registrationUsernameThe 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
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.toString()
-
Constructor Details
-
UserRegistration
public UserRegistration()
-
-
Method Details
-
getUserType
The type of user to register this user as.- See Also:
-
getFullName
Full name of the user -
getUsername
UsernameOnly used when
AuthRegistrationProperties.isEmailAsUsername()
is disabled -
getEmail
Email address -
getPassword
- See Also:
-
getPasswordConfirmation
Must match the givenpassword
- See Also:
-
getClientId
The application's client_id that this user is registering to -
getReturnTo
The location to which the user is forwarded after registration -
getPreview
True if this registration is in a preview context -
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
The type of user to register this user as.- See Also:
-
setFullName
Full name of the user -
setUsername
UsernameOnly used when
AuthRegistrationProperties.isEmailAsUsername()
is disabled -
setEmail
Email address -
setPassword
- See Also:
-
setPasswordConfirmation
Must match the givenpassword
- See Also:
-
setClientId
The application's client_id that this user is registering to -
setReturnTo
The location to which the user is forwarded after registration -
setPreview
True if this registration is in a preview context -
setAttributes
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
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-