io.micronaut.security.oauth2.openid.endpoints.authorization

Class AuthenticationRequestAdapter

java.lang.Object

io.micronaut.security.oauth2.openid.endpoints.authorization.AuthenticationRequestAdapter

All Implemented Interfaces:

AuthenticationRequest, AuthorizationEndpointRequestConfiguration

public class AuthenticationRequestAdapter
extends java.lang.Object
implements AuthenticationRequest

Provides an AuthenticationRequest by combining OauthConfiguration, StateFactory, NonceProvider, AuthorizationEndpoint.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields inherited from interface io.micronaut.security.oauth2.openid.endpoints.authorization.AuthenticationRequest

PARAMETER_ACR_VALUES, PARAMETER_CLIENT_ID, PARAMETER_DISPLAY, PARAMETER_ID_TOKEN_HINT, PARAMETER_LOGIN_HINT, PARAMETER_MAX_AGE, PARAMETER_NONCE, PARAMETER_PROMPT, PARAMETER_REDIRECT_URI, PARAMETER_RESPONSE_MODE, PARAMETER_RESPONSE_TYPE, PARAMETER_SCOPE, PARAMETER_STATE, PARAMETER_UI_LOCALES

Constructor Summary

Constructors

Constructor and Description
AuthenticationRequestAdapter(io.micronaut.http.HttpRequest<?> request, OauthConfiguration oauthConfiguration, AuthorizationEndpointRequestConfiguration authorizationEndpointConfiguration, StateFactory stateFactory, NonceProvider nonceProvider, LoginHintProvider loginHintProvider, IdTokenHintProvider idTokenHintProvider)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAcrValues()
java.lang.String	getClientId()
Display	getDisplay()
java.lang.String	getIdTokenHint()
java.lang.String	getLoginHint()
java.lang.Integer	getMaxAge()
java.lang.String	getNonce()
Prompt	getPrompt()
java.lang.String	getRedirectUri()
java.lang.String	getResponseMode()
java.lang.String	getResponseType()
java.util.List<java.lang.String>	getScopes()
java.lang.String	getState()
java.util.List<java.lang.String>	getUiLocales()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationRequestAdapter

public AuthenticationRequestAdapter(io.micronaut.http.HttpRequest<?> request,
                                    OauthConfiguration oauthConfiguration,
                                    AuthorizationEndpointRequestConfiguration authorizationEndpointConfiguration,
                                    @Nullable
                                    StateFactory stateFactory,
                                    @Nullable
                                    NonceProvider nonceProvider,
                                    @Nullable
                                    LoginHintProvider loginHintProvider,
                                    @Nullable
                                    IdTokenHintProvider idTokenHintProvider)

Parameters:

request - The original request prior redirect.

oauthConfiguration - OAuth 2.0 Configuration

authorizationEndpointConfiguration - Authorization Endpoint Configuration

stateFactory - State Provider

nonceProvider - Nonce Provider

loginHintProvider - Login Hint Provider

idTokenHintProvider - Id Token Hint Provider

Method Detail

getClientId

@Nonnull
public java.lang.String getClientId()

Specified by:

getClientId in interface AuthenticationRequest

Returns:

OAuth 2.0 Client Identifier valid at the Authorization Server.

getState

@Nullable
public java.lang.String getState()

Specified by:

getState in interface AuthenticationRequest

Returns:

Opaque value used to maintain state between the request and the callback.

getNonce

@Nullable
public java.lang.String getNonce()

Specified by:

getNonce in interface AuthenticationRequest

Returns:

String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

getScopes

@Nonnull
public java.util.List<java.lang.String> getScopes()

Specified by:

getScopes in interface AuthorizationEndpointRequestConfiguration

Returns:

OAuth 2.0 scopes.

getResponseType

@Nonnull
public java.lang.String getResponseType()

Specified by:

getResponseType in interface AuthorizationEndpointRequestConfiguration

Returns:

OAuth 2.0 Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used.

getRedirectUri

@Nullable
public java.lang.String getRedirectUri()

Specified by:

getRedirectUri in interface AuthorizationEndpointRequestConfiguration

Returns:

Redirection URI to which the response will be sent.

getResponseMode

@Nullable
public java.lang.String getResponseMode()

Specified by:

getResponseMode in interface AuthorizationEndpointRequestConfiguration

Returns:

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint.

getDisplay

@Nullable
public Display getDisplay()

Specified by:

getDisplay in interface AuthorizationEndpointRequestConfiguration

Returns:

ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.

getPrompt

@Nullable
public Prompt getPrompt()

Specified by:

getPrompt in interface AuthorizationEndpointRequestConfiguration

Returns:

Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.

getMaxAge

@Nullable
public java.lang.Integer getMaxAge()

Specified by:

getMaxAge in interface AuthorizationEndpointRequestConfiguration

Returns:

Maximum Authentication Age.

getUiLocales

@Nullable
public java.util.List<java.lang.String> getUiLocales()

Specified by:

getUiLocales in interface AuthorizationEndpointRequestConfiguration

Returns:

End-User's preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference.

getIdTokenHint

@Nullable
public java.lang.String getIdTokenHint()

Specified by:

getIdTokenHint in interface AuthenticationRequest

Returns:

Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. If the End-User identified by the ID Token is logged in or is logged in by the request, then the Authorization Server returns a positive response; otherwise, it SHOULD return an error, such as login_required.

getLoginHint

@Nullable
public java.lang.String getLoginHint()

Specified by:

getLoginHint in interface AuthenticationRequest

Returns:

Hint to the Authorization Server about the login identifier the End-User might use to log in.

getAcrValues

@Nullable
public java.util.List<java.lang.String> getAcrValues()

Specified by:

getAcrValues in interface AuthorizationEndpointRequestConfiguration

Returns:

Requested Authentication Context Class Reference values.