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

Interface OauthUserDetailsMapper

public interface OauthUserDetailsMapper

A contract for mapping an OAuth 2.0 token endpoint response to a UserDetails object.

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TOKEN_KEY A key to be stored in the user details to store the access token returned by the provider.
static java.lang.String	PROVIDER_KEY A key to be stored in the user details to denote which provider authenticated the user.
static java.lang.String	REFRESH_TOKEN_KEY A key to be stored in the user details to store the refresh token returned by the provider.

Method Summary

Modifier and Type	Method and Description
default org.reactivestreams.Publisher<AuthenticationResponse>	createAuthenticationResponse(TokenResponse tokenResponse, State state) Convert the token response and state into an authentication response.
org.reactivestreams.Publisher<UserDetails>	createUserDetails(TokenResponse tokenResponse) Deprecated. Use instead. This method will only be called if the new method is not overridden.

Field Detail

PROVIDER_KEY

static final java.lang.String PROVIDER_KEY

A key to be stored in the user details to denote which provider authenticated the user.

See Also:

Constant Field Values

ACCESS_TOKEN_KEY

static final java.lang.String ACCESS_TOKEN_KEY

A key to be stored in the user details to store the access token returned by the provider.

See Also:

Constant Field Values

REFRESH_TOKEN_KEY

static final java.lang.String REFRESH_TOKEN_KEY

A key to be stored in the user details to store the refresh token returned by the provider.

See Also:

Constant Field Values

Method Detail

createUserDetails

@Deprecated
org.reactivestreams.Publisher<UserDetails> createUserDetails(TokenResponse tokenResponse)

Deprecated. Use instead. This method will only be called if the new method is not overridden.

Convert the token response into a user details.

Parameters:

tokenResponse - The token response

Returns:

The user details

createAuthenticationResponse

default org.reactivestreams.Publisher<AuthenticationResponse> createAuthenticationResponse(TokenResponse tokenResponse,
                                                                                           @Nullable
                                                                                           State state)

Convert the token response and state into an authentication response.

Parameters:

tokenResponse - The token response

state - The OAuth state

Returns:

The authentication response