Class UserAttributesRequest
java.lang.Object
com.broadleafcommerce.auth.resource.domain.UserAttributesRequest
A request DTO to adjust the attributes on a particular
User
.
By itself, this request has no affect on a user. It simply persists the user attributes to the database. At that point, it is up to the implementer to handle those attributes.
A common use-case is adding additional claims to a token. To do this, it is required to implement
a custom JwtAccessTokenEnhancer
and manually add any claims.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
The values to add to theUser's
attributes.The id of the user to add additional attributes.int
hashCode()
void
setPayload
(Map<String, Object> payload) The values to add to theUser's
attributes.void
The id of the user to add additional attributes.toString()
-
Constructor Details
-
UserAttributesRequest
public UserAttributesRequest() -
UserAttributesRequest
-
-
Method Details
-
getUserId
The id of the user to add additional attributes.- See Also:
-
getPayload
The values to add to theUser's
attributes.This is a key/value pair, and the key(s) should be a unique value. If these attributes are intended to be used as additional claims, a custom
JwtAccessTokenEnhancer
must be implemented.- Returns:
- the values to add into the
User's
attributes - See Also:
-
setUserId
The id of the user to add additional attributes.- See Also:
-
setPayload
The values to add to theUser's
attributes.This is a key/value pair, and the key(s) should be a unique value. If these attributes are intended to be used as additional claims, a custom
JwtAccessTokenEnhancer
must be implemented.- Parameters:
payload
- the values to add to theUser's
attributes- See Also:
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-