Package 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("authorization") public static class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties extends DefaultEndpointConfiguration implements AuthorizationEndpointConfiguration
Authorization endpoint configuration.

  • Constructor Details

    • AuthorizationEndpointConfigurationProperties

      public AuthorizationEndpointConfigurationProperties()

  • Method Details

    • getResponseType

      @NonNull public @NonNull ResponseType getResponseType()
      Specified by:
      getResponseType in interface AuthorizationEndpointConfiguration
      Returns:
      Value that determines the authorization processing flow to be used

    • setResponseType

      public void setResponseType(@NonNull @NonNull ResponseType responseType)
      Determines the authorization processing flow to be used. Default value (code).
      Parameters:
      responseType - The response type

    • getResponseMode

      public Optional<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 @Nullable String responseMode)
      Mechanism to be used for returning authorization response parameters from the authorization endpoint.
      Parameters:
      responseMode - The response mode

    • getDisplay

      public 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 @Nullable Display display)
      Controls how the authentication interface is displayed.
      Parameters:
      display - The display

    • getPrompt

      public 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 @Nullable Prompt prompt)
      Controls how the authentication server prompts the user.
      Parameters:
      prompt - The prompt type

    • getMaxAge

      public Optional<Integer> getMaxAge()
      Specified by:
      getMaxAge in interface AuthorizationEndpointConfiguration
      Returns:
      Maximum Authentication Age.

    • setMaxAge

      public void setMaxAge(@Nullable @Nullable Integer maxAge)
      Maximum authentication age.
      Parameters:
      maxAge - Maximum authentication age.

    • getUiLocales

      public Optional<List<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 @Nullable List<String> uiLocales)
      Preferred locales for authentication.
      Parameters:
      uiLocales - Preferred locales

    • getAcrValues

      public Optional<List<String>> getAcrValues()
      Specified by:
      getAcrValues in interface AuthorizationEndpointConfiguration
      Returns:
      Requested Authentication Context Class Reference values.

    • getCodeChallengeMethod

      @NonNull public @NonNull Optional<String> getCodeChallengeMethod()
      Specified by:
      getCodeChallengeMethod in interface OauthAuthorizationEndpointConfiguration
      Returns:
      Code challenge method to use for PKCE.

    • setCodeChallengeMethod

      public void setCodeChallengeMethod(@Nullable @Nullable String codeChallengeMethod)
      Code Challenge Method to use for PKCE.
      Parameters:
      codeChallengeMethod - Code Challenge Method

    • setAcrValues

      public void setAcrValues(@Nullable @Nullable List<String> acrValues)
      Authentication class reference values.
      Parameters:
      acrValues - Authentication class reference values