Package io.micronaut.security.authentication

Class ClientAuthentication

java.lang.Object

io.micronaut.security.authentication.ClientAuthentication

All Implemented Interfaces:

Authentication, Serializable, Principal

public class ClientAuthentication
extends Object
implements Authentication

An implementation of the Authentication interface intended to be used by clients that deserialize token information into an authentication.

Since:

3.0.0

Author:

James Kleeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientAuthentication(String name, Map<String,Object> attributes)

Method Summary

Modifier and Type	Method	Description
@NonNull Map<String,Object>	getAttributes()	In order to correctly implement the Serializable specification, this map should be Map<String, Serializable>, however that would place a burden on those not requiring serialization, forcing their values to conform to that spec.
String	getName()
@NonNull Collection<String>	getRoles()	This implementation relies on a key being stored in the claims called "rolesKey" that stores the key where the roles are stored.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Constructor Details

ClientAuthentication

public ClientAuthentication(String name,
 Map<String,Object> attributes)

Parameters:

name - The name of the authentication

attributes - The attributes for the authentication

Method Details

getName

public String getName()

Specified by:

getName in interface Principal

getAttributes

@NonNull
public @NonNull Map<String,Object> getAttributes()

Description copied from interface: Authentication

In order to correctly implement the Serializable specification, this map should be Map<String, Serializable>, however that would place a burden on those not requiring serialization, forcing their values to conform to that spec. This is left intentionally as Object in order to meet both use cases and those requiring serialization must ensure all values in the map implement Serializable.

Specified by:

getAttributes in interface Authentication

Returns:

Any additional attributes in the authentication

getRoles

@NonNull
public @NonNull Collection<String> getRoles()

This implementation relies on a key being stored in the claims called "rolesKey" that stores the key where the roles are stored. This claim is provided by the claims set generator in the jwt module.

Specified by:

getRoles in interface Authentication

Returns:

Any roles found in the attributes