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

Interface OpenIdUserDetailsMapper

All Known Implementing Classes:

DefaultOpenIdUserDetailsMapper

@DefaultImplementation(value=DefaultOpenIdUserDetailsMapper.class)
public interface OpenIdUserDetailsMapper

Responsible for converting an OpenID token response to a UserDetails representing the authenticated user.

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPENID_TOKEN_KEY

Method Summary

Modifier and Type	Method and Description
default AuthenticationResponse	createAuthenticationResponse(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims, State state)
UserDetails	createUserDetails(java.lang.String providerName, OpenIdTokenResponse tokenResponse, OpenIdClaims openIdClaims) Deprecated. Use createAuthenticationResponse(String, OpenIdTokenResponse, OpenIdClaims, State) instead. This method will only be called if the new method is not implemented.

Field Detail

OPENID_TOKEN_KEY

static final java.lang.String OPENID_TOKEN_KEY

See Also:

Constant Field Values

Method Detail

createUserDetails

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

Deprecated. Use createAuthenticationResponse(String, OpenIdTokenResponse, OpenIdClaims, State) instead. This method will only be called if the new method is not implemented.

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

Returns:

A user details object

createAuthenticationResponse

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

Parameters:

providerName - The OpenID provider name

tokenResponse - The token response

openIdClaims - The OpenID claims

state - The state of the response

Returns:

An authentication response