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

Class AuthorizationEndpointConfigurationProperties

java.lang.Object

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

All Implemented Interfaces:

AuthorizationEndpoint, AuthorizationEndpointRequestConfiguration, Endpoint

@ConfigurationProperties(value="micronaut.security.oauth2.authorization")
public class AuthorizationEndpointConfigurationProperties
extends java.lang.Object
implements AuthorizationEndpoint, AuthorizationEndpointRequestConfiguration

ConfigurationProperties for OAuth 2.0 authorization endpoint.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RESPONSEMODE Default response mode.
static java.lang.String	DEFAULT_RESPONSETYPE Default response type.
static java.util.List<java.lang.String>	DEFAULT_SCOPE Default scope.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
AuthorizationEndpointConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAcrValues()
Display	getDisplay()
java.lang.Integer	getMaxAge()
Prompt	getPrompt()
java.lang.String	getRedirectUri()
java.lang.String	getResponseMode()
java.lang.String	getResponseType()
java.util.List<java.lang.String>	getScopes()
java.util.List<java.lang.String>	getUiLocales()
java.lang.String	getUrl()
void	setAcrValues(java.util.List<java.lang.String> acrValues) Requested Authentication Context Class Reference values.
void	setDisplay(Display display) ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
void	setMaxAge(java.lang.Integer maxAge) Maximum Authentication Age.
void	setPrompt(Prompt prompt) Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
void	setRedirectUri(java.lang.String redirectUri) Redirection URI to which the response will be sent.
void	setResponseMode(java.lang.String responseMode) Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint.
void	setResponseType(java.lang.String responseType) Set OAuth 2.0 Response Type.
void	setScopes(java.util.List<java.lang.String> scopes) Sets OAuth 2.0 scopes.
void	setUiLocales(java.util.List<java.lang.String> uiLocales) End-User's preferred languages and scripts for the user interface.
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_RESPONSETYPE

public static final java.lang.String DEFAULT_RESPONSETYPE

Default response type.

See Also:

Constant Field Values

DEFAULT_RESPONSEMODE

public static final java.lang.String DEFAULT_RESPONSEMODE

Default response mode.

See Also:

Constant Field Values

DEFAULT_SCOPE

public static final java.util.List<java.lang.String> DEFAULT_SCOPE

Default scope.

Constructor Detail

AuthorizationEndpointConfigurationProperties

public AuthorizationEndpointConfigurationProperties()

Method Detail

getUrl

@Nullable
public java.lang.String getUrl()

Specified by:

getUrl in interface Endpoint

Returns:

Endpoint's url.

setUrl

public void setUrl(@Nullable
                   java.lang.String url)

Parameters:

url - the authorization endpoint's url.

getScopes

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

Specified by:

getScopes in interface AuthorizationEndpointRequestConfiguration

Returns:

OAuth 2.0 scopes.

setScopes

public void setScopes(@Nonnull
                      java.util.List<java.lang.String> scopes)

Sets OAuth 2.0 scopes. Default value (['openid', 'email', 'profile']).

Parameters:

scopes - 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.

setResponseType

public void setResponseType(@Nonnull
                            java.lang.String responseType)

Set OAuth 2.0 Response Type. Default value ("code").

Parameters:

responseType - OAuth 2.0 Response Type.

getRedirectUri

@Nullable
public java.lang.String getRedirectUri()

Specified by:

getRedirectUri in interface AuthorizationEndpointRequestConfiguration

Returns:

Redirection URI to which the response will be sent.

setRedirectUri

public void setRedirectUri(java.lang.String redirectUri)

Redirection URI to which the response will be sent. Default value (http://localhost:8080/auth/code).

Parameters:

redirectUri - 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.

setResponseMode

public void setResponseMode(@Nullable
                            java.lang.String responseMode)

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint. Default value ("query").

Parameters:

responseMode - Informs the authorization server of the mechanism to be used for returning parameters from the authorization endpoint. Allows null because the spec says "The use of this parameter is NOT RECOMMENDED when the Response Mode that would be requested is the default mode specified for the Response Type".

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.

setDisplay

public void setDisplay(@Nullable
                       Display display)

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

Parameters:

display - 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.

setPrompt

public void setPrompt(@Nullable
                      Prompt prompt)

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

Parameters:

prompt - 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.

setMaxAge

public void setMaxAge(@Nullable
                      java.lang.Integer maxAge)

Maximum Authentication Age. Default value (null).

Parameters:

maxAge - 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.

setUiLocales

public void setUiLocales(@Nullable
                         java.util.List<java.lang.String> uiLocales)

End-User's preferred languages and scripts for the user interface. Default value (null).

Parameters:

uiLocales - End-User's preferred languages and scripts for the user interface

getAcrValues

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

Specified by:

getAcrValues in interface AuthorizationEndpointRequestConfiguration

Returns:

Requested Authentication Context Class Reference values.

setAcrValues

public void setAcrValues(@Nullable
                         java.util.List<java.lang.String> acrValues)

Requested Authentication Context Class Reference values. Default value (null).

Parameters:

acrValues - Requested Authentication Context Class Reference values.