io.micronaut.security.oauth2.endpoint.token.response

Class DefaultOpenIdUserDetailsMapper

java.lang.Object

io.micronaut.security.oauth2.endpoint.token.response.DefaultOpenIdUserDetailsMapper

All Implemented Interfaces:

OpenIdUserDetailsMapper

@Singleton
 @Requires(configuration="io.micronaut.security.token.jwt")
public class DefaultOpenIdUserDetailsMapper
extends java.lang.Object
implements OpenIdUserDetailsMapper

The default implementation of OpenIdUserDetailsMapper that uses the subject claim for the username and populates the attributes with the non JWT standard claims. If an OpenIdUserDetailsMapper bean is created with a named qualifier that is the same name of the provider, that bean will be used instead of this one.

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields inherited from interface io.micronaut.security.oauth2.endpoint.token.response.OpenIdUserDetailsMapper

OPENID_TOKEN_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration openIdAdditionalClaimsConfiguration) Deprecated. Use DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration, AuthenticationModeConfiguration) instead.
DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration openIdAdditionalClaimsConfiguration, AuthenticationModeConfiguration authenticationModeConfiguration) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	buildAttributes(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims)
AuthenticationResponse	createAuthenticationResponse(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims, State state)
UserDetails	createUserDetails(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims)
protected java.util.List<java.lang.String>	getRoles(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims)
protected java.lang.String	getUsername(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOpenIdUserDetailsMapper

@Inject
public DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration openIdAdditionalClaimsConfiguration,
                                              AuthenticationModeConfiguration authenticationModeConfiguration)

Default constructor.

Parameters:

openIdAdditionalClaimsConfiguration - The additional claims configuration

authenticationModeConfiguration - Authentication Mode Configuration

DefaultOpenIdUserDetailsMapper

@Deprecated
public DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration openIdAdditionalClaimsConfiguration)

Deprecated. Use DefaultOpenIdUserDetailsMapper(OpenIdAdditionalClaimsConfiguration, AuthenticationModeConfiguration) instead.

Parameters:

openIdAdditionalClaimsConfiguration - The additional claims configuration

Method Detail

createUserDetails

@NonNull
public UserDetails createUserDetails(java.lang.String providerName,
                                              OpenIdTokenResponse tokenResponse,
                                              OpenIdClaims openIdClaims)

Specified by:

createUserDetails in interface OpenIdUserDetailsMapper

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

Returns:

A user details object

createAuthenticationResponse

@NonNull
public AuthenticationResponse createAuthenticationResponse(java.lang.String providerName,
                                                                    OpenIdTokenResponse tokenResponse,
                                                                    OpenIdClaims openIdClaims,
                                                                    @Nullable
                                                                    State state)

Specified by:

createAuthenticationResponse in interface OpenIdUserDetailsMapper

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

state - The state of the response

Returns:

An authentication response

buildAttributes

protected java.util.Map<java.lang.String,java.lang.Object> buildAttributes(java.lang.String providerName,
                                                                           OpenIdTokenResponse tokenResponse,
                                                                           OpenIdClaims openIdClaims)

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

Returns:

The attributes to set in the UserDetails

getRoles

protected java.util.List<java.lang.String> getRoles(java.lang.String providerName,
                                                    OpenIdTokenResponse tokenResponse,
                                                    OpenIdClaims openIdClaims)

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

Returns:

The roles to set in the UserDetails

getUsername

protected java.lang.String getUsername(java.lang.String providerName,
                                       OpenIdTokenResponse tokenResponse,
                                       OpenIdClaims openIdClaims)

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

Returns:

The username to set in the UserDetails