io.micronaut.security.authentication

Class UserDetails

java.lang.Object

io.micronaut.security.authentication.UserDetails

All Implemented Interfaces:

AuthenticationResponse, Serializable

public class UserDetails
extends Object
implements AuthenticationResponse

Authenticated user's representation.

Since:

1.0

Author:

Sergio del Amo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserDetails(String username, Collection<String> roles)
UserDetails(String username, Collection<String> roles, Map<String,Object> attributes)

Method Summary

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

Parameters:

username - e.g. admin

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

UserDetails

public UserDetails(String username,
                   Collection<String> roles,
                   Map<String,Object> attributes)

Parameters:

username - e.g. admin

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

attributes - User's attributes

Method Detail

getAttributes

public Map<String,Object> getAttributes(String rolesKey,
                                        String usernameKey)

Parameters:

rolesKey - the key for the roles attribute

usernameKey - the key for the username attribute

Returns:

User's attributes

getUsername

public String getUsername()

username getter.

Returns:

e.g. admin

setUsername

public void setUsername(String username)

username setter.

Parameters:

username - e.g. admin

getRoles

public Collection<String> getRoles()

roles getter.

Returns:

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

setRoles

public void setRoles(Collection<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 Optional<String> getMessage()

Specified by:

getMessage in interface AuthenticationResponse

Returns:

A message if the response chose to include one

setAttributes

public void setAttributes(@Nullable
                          Map<String,Object> attributes)

Sets user's attributes.

Parameters:

attributes - User's attributes.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object