io.micronaut.security.oauth2.configuration

Class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.endpoints.DefaultEndpointConfiguration

io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties

All Implemented Interfaces:

AuthorizationEndpointConfiguration, EndpointConfiguration, OauthAuthorizationEndpointConfiguration

Enclosing class:

OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

@ConfigurationProperties(value="authorization")
public static class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties
extends DefaultEndpointConfiguration
implements AuthorizationEndpointConfiguration

Authorization endpoint configuration.

Constructor Summary

Constructors

Constructor and Description
AuthorizationEndpointConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.List<java.lang.String>>	getAcrValues()
java.util.Optional<java.lang.String>	getCodeChallengeMethod()
java.util.Optional<Display>	getDisplay()
java.util.Optional<java.lang.Integer>	getMaxAge()
java.util.Optional<Prompt>	getPrompt()
java.util.Optional<java.lang.String>	getResponseMode()
ResponseType	getResponseType()
java.util.Optional<java.util.List<java.lang.String>>	getUiLocales()
void	setAcrValues(java.util.List<java.lang.String> acrValues) Authentication class reference values.
void	setCodeChallengeMethod(java.lang.String codeChallengeMethod) Code Challenge Method to use for PKCE.
void	setDisplay(Display display) Controls how the authentication interface is displayed.
void	setMaxAge(java.lang.Integer maxAge) Maximum authentication age.
void	setPrompt(Prompt prompt) Controls how the authentication server prompts the user.
void	setResponseMode(java.lang.String responseMode) Mechanism to be used for returning authorization response parameters from the authorization endpoint.
void	setResponseType(ResponseType responseType) Determines the authorization processing flow to be used.
void	setUiLocales(java.util.List<java.lang.String> uiLocales) Preferred locales for authentication.

Methods inherited from class io.micronaut.security.oauth2.configuration.endpoints.DefaultEndpointConfiguration

getUrl, setUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.security.oauth2.configuration.endpoints.EndpointConfiguration

getUrl

Constructor Detail

AuthorizationEndpointConfigurationProperties

public AuthorizationEndpointConfigurationProperties()

Method Detail

getResponseType

@NonNull
public ResponseType getResponseType()

Specified by:

getResponseType in interface AuthorizationEndpointConfiguration

Returns:

Value that determines the authorization processing flow to be used

setResponseType

public void setResponseType(@NonNull
                            ResponseType responseType)

Determines the authorization processing flow to be used. Default value (code).

Parameters:

responseType - The response type

getResponseMode

public java.util.Optional<java.lang.String> getResponseMode()

Specified by:

getResponseMode in interface AuthorizationEndpointConfiguration

Returns:

Mechanism to be used for returning Authorization Response parameters from the Authorization Endpoint.

setResponseMode

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

Mechanism to be used for returning authorization response parameters from the authorization endpoint.

Parameters:

responseMode - The response mode

getDisplay

public java.util.Optional<Display> getDisplay()

Specified by:

getDisplay in interface AuthorizationEndpointConfiguration

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)

Controls how the authentication interface is displayed.

Parameters:

display - The display

getPrompt

public java.util.Optional<Prompt> getPrompt()

Specified by:

getPrompt in interface AuthorizationEndpointConfiguration

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)

Controls how the authentication server prompts the user.

Parameters:

prompt - The prompt type

getMaxAge

public java.util.Optional<java.lang.Integer> getMaxAge()

Specified by:

getMaxAge in interface AuthorizationEndpointConfiguration

Returns:

Maximum Authentication Age.

setMaxAge

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

Maximum authentication age.

Parameters:

maxAge - Maximum authentication age.

getUiLocales

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

Specified by:

getUiLocales in interface AuthorizationEndpointConfiguration

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)

Preferred locales for authentication.

Parameters:

uiLocales - Preferred locales

getAcrValues

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

Specified by:

getAcrValues in interface AuthorizationEndpointConfiguration

Returns:

Requested Authentication Context Class Reference values.

getCodeChallengeMethod

@NonNull
public java.util.Optional<java.lang.String> getCodeChallengeMethod()

Specified by:

getCodeChallengeMethod in interface OauthAuthorizationEndpointConfiguration

Returns:

Code challenge method to use for PKCE.

setCodeChallengeMethod

public void setCodeChallengeMethod(@Nullable
                                   java.lang.String codeChallengeMethod)

Code Challenge Method to use for PKCE.

Parameters:

codeChallengeMethod - Code Challenge Method

setAcrValues

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

Authentication class reference values.

Parameters:

acrValues - Authentication class reference values