Package io.micronaut.security.authentication

Class UserDetails

java.lang.Object

io.micronaut.security.authentication.UserDetails

All Implemented Interfaces:

AuthenticationResponse, java.io.Serializable

public class UserDetails
extends java.lang.Object
implements AuthenticationResponse

Authenticated user's representation.

Since:

1.0

Author:

Sergio del Amo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserDetails(java.lang.String username, java.util.Collection<java.lang.String> roles)
UserDetails(java.lang.String username, java.util.Collection<java.lang.String> roles, java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.Object>	getAttributes(java.lang.String rolesKey, java.lang.String usernameKey)
java.util.Optional<java.lang.String>	getMessage()
java.util.Collection<java.lang.String>	getRoles()	roles getter.
java.lang.String	getUsername()	username getter.
int	hashCode()
boolean	isAuthenticated()	Defaults to false.
void	setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)	Sets user's attributes.
void	setRoles(java.util.Collection<java.lang.String> roles)	roles setter.
void	setUsername(java.lang.String username)	username setter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserDetails

public UserDetails(java.lang.String username,
                   java.util.Collection<java.lang.String> roles)

Parameters:

username - e.g. admin

roles - e.g. ['ROLE_ADMIN', 'ROLE_USER']

UserDetails

public UserDetails(java.lang.String username,
                   java.util.Collection<java.lang.String> roles,
                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Parameters:

username - e.g. admin

roles - e.g. ['ROLE_ADMIN', 'ROLE_USER']

attributes - User's attributes

Method Detail

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes(java.lang.String rolesKey,
                                                                            java.lang.String usernameKey)

Parameters:

rolesKey - the key for the roles attribute

usernameKey - the key for the username attribute

Returns:

User's attributes

getUsername

public java.lang.String getUsername()

username getter.

Returns:

e.g. admin

setUsername

public void setUsername(java.lang.String username)

username setter.

Parameters:

username - e.g. admin

getRoles

public java.util.Collection<java.lang.String> getRoles()

roles getter.

Returns:

e.g. ['ROLE_USER', 'ROLE_ADMIN']

setRoles

public void setRoles(java.util.Collection<java.lang.String> roles)

roles setter.

Parameters:

roles - e.g. ['ROLE_USER', 'ROLE_ADMIN']

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: AuthenticationResponse

Defaults to false.

Specified by:

isAuthenticated in interface AuthenticationResponse

Returns:

true or false depending on whether the user is authenticated

getMessage

public java.util.Optional<java.lang.String> getMessage()

Specified by:

getMessage in interface AuthenticationResponse

Returns:

A message if the response chose to include one

setAttributes

public void setAttributes(@Nullable
                          java.util.Map<java.lang.String,java.lang.Object> attributes)

Sets user's attributes.

Parameters:

attributes - User's attributes.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object