Class OauthCodeTokenRequestContext

java.lang.Object

io.micronaut.security.oauth2.endpoint.token.request.context.AbstractTokenRequestContext<Map<String,String>, TokenResponse>

io.micronaut.security.oauth2.endpoint.token.request.context.OauthCodeTokenRequestContext

All Implemented Interfaces:

TokenRequestContext<Map<String,String>, TokenResponse>

public class OauthCodeTokenRequestContext
extends AbstractTokenRequestContext<Map<String,String>, TokenResponse>

A token request context for sending an authorization code grant request to an OAuth 2.0 provider.

The redirect_uri parameter of the token request is built from the application's own callback route via OauthRouteUrlBuilder, never from the state parameter received in the authorization response, which is controlled by the party redirecting the browser to the callback (see RFC 6749 sections 4.1.3 and 10.6).

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields inherited from class AbstractTokenRequestContext

clientConfiguration, mediaType, tokenEndpoint

Constructor Summary

Constructors

Constructor	Description
OauthCodeTokenRequestContext(AuthorizationResponse authorizationResponse, SecureEndpoint tokenEndpoint, OauthClientConfiguration clientConfiguration, @Nullable String codeVerifier)	Deprecated, for removal: This API element is subject to removal in a future version. Use OauthCodeTokenRequestContext(AuthorizationResponse, OauthRouteUrlBuilder, SecureEndpoint, OauthClientConfiguration, String).
OauthCodeTokenRequestContext(AuthorizationResponse authorizationResponse, @Nullable OauthRouteUrlBuilder oauthRouteUrlBuilder, SecureEndpoint tokenEndpoint, OauthClientConfiguration clientConfiguration, @Nullable String codeVerifier)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getCodeVerifier()
io.micronaut.core.type.Argument<?>	getErrorResponseType()
Map<String,String>	getGrant()
io.micronaut.core.type.Argument<TokenResponse>	getResponseType()

Methods inherited from class AbstractTokenRequestContext

getClientConfiguration, getEndpoint, getMediaType

Methods inherited from class Object

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

Constructor Details

OauthCodeTokenRequestContext

@Deprecated(forRemoval=true,
            since="5.5.2")
public OauthCodeTokenRequestContext(AuthorizationResponse authorizationResponse,
 SecureEndpoint tokenEndpoint,
 OauthClientConfiguration clientConfiguration,
 @Nullable String codeVerifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Use OauthCodeTokenRequestContext(AuthorizationResponse, OauthRouteUrlBuilder, SecureEndpoint, OauthClientConfiguration, String). A context created with this constructor does not send the redirect_uri parameter to the token endpoint.

Parameters:

authorizationResponse - The authorization response

tokenEndpoint - The token endpoint

clientConfiguration - The client configuration

codeVerifier - The PKCE code_verifier

OauthCodeTokenRequestContext

public OauthCodeTokenRequestContext(AuthorizationResponse authorizationResponse,
 @Nullable OauthRouteUrlBuilder oauthRouteUrlBuilder,
 SecureEndpoint tokenEndpoint,
 OauthClientConfiguration clientConfiguration,
 @Nullable String codeVerifier)

Parameters:

authorizationResponse - The authorization response

oauthRouteUrlBuilder - The OAuth 2.0 route URL builder used to build the redirect_uri

tokenEndpoint - The token endpoint

clientConfiguration - The client configuration

codeVerifier - The PKCE code_verifier

Since:

5.5.2

Method Details

getGrant

public Map<String,String> getGrant()

Returns:

The grant or body of the request

getResponseType

public io.micronaut.core.type.Argument<TokenResponse> getResponseType()

Returns:

The response argument

getErrorResponseType

public io.micronaut.core.type.Argument<?> getErrorResponseType()

Returns:

The error response argument

getCodeVerifier

public @Nullable String getCodeVerifier()

Returns:

The PKCE code verifier

Since:

3.9.0