UserRegistration (Broadleaf Authentication Services 1.6.1-SNAPSHOT API)

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 and Description

UserRegistration()

Constructors
Constructor and Description
`UserRegistration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 to
`String`	`getEmail()` Email address
`String`	`getFullName()` Full name of the user
`String`	`getPassword()`
`String`	`getPasswordConfirmation()` Must match the given `password`
`Boolean`	`getPreview()` True if this registration is in a preview context
`String`	`getReturnTo()` The location to which the user is forwarded after registration
`String`	`getUsername()` Username
`String`	`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 to
`void`	`setEmail(String email)` Email address
`void`	`setFullName(String fullName)` Full name of the user
`void`	`setPassword(String password)`
`void`	`setPasswordConfirmation(String passwordConfirmation)` Must match the given `password`
`void`	`setPreview(Boolean preview)` True if this registration is in a preview context
`void`	`setReturnTo(String returnTo)` The location to which the user is forwarded after registration
`void`	`setUsername(String username)` Username
`void`	`setUserType(String userType)` The type of user to register this user as.
`String`	`toString()`

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

- Constructor Detail
  - UserRegistration
```
public UserRegistration()
```
- 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()
```
    Username
    Only 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 given password
    
    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 via UserCreationEvent.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)
```
    Username
    Only 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 given password
    
    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 via UserCreationEvent.attributes.
    
    See Also:
    
    UserCreationEvent.attributes
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UserRegistration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserRegistration

Method Detail

getUserType

getFullName

getUsername

getEmail

getPassword

getPasswordConfirmation

getClientId

getReturnTo

getPreview

getAttributes

setUserType

setFullName

setUsername

setEmail

setPassword

setPasswordConfirmation

setClientId

setReturnTo

setPreview

setAttributes

equals

canEqual

hashCode

toString