Class DefaultOpenIdClient

java.lang.Object
io.micronaut.security.oauth2.client.DefaultOpenIdClient
All Implemented Interfaces:
OauthClient, OpenIdClient

public class DefaultOpenIdClient extends Object implements OpenIdClient
The default implementation of OpenIdClient.
Since:
1.2.0
Author:
James Kleeh
  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface OauthClient
      Returns:
      The provider name
    • supportsEndSession

      public boolean supportsEndSession()
      Specified by:
      supportsEndSession in interface OpenIdClient
      Returns:
      True if this client supports end session
    • endSessionRedirect

      public Optional<io.micronaut.http.MutableHttpResponse<?>> endSessionRedirect(io.micronaut.http.HttpRequest<?> request, Authentication authentication)
      Description copied from interface: OpenIdClient
      Redirects to the end session endpoint of an OpenID provider. Returns an empty optional if the provider does not support end session or an EndSessionEndpoint could not be resolved for the provider.
      Specified by:
      endSessionRedirect in interface OpenIdClient
      Parameters:
      request - The current request
      authentication - The current authentication
      Returns:
      An optional response
    • authorizationRedirect

      public org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> authorizationRedirect(io.micronaut.http.HttpRequest<?> originating)
      Description copied from interface: OauthClient
      Responsible for redirecting to the authorization endpoint.
      Specified by:
      authorizationRedirect in interface OauthClient
      Parameters:
      originating - The originating request
      Returns:
      A response publisher
    • onCallback

      public org.reactivestreams.Publisher<AuthenticationResponse> onCallback(io.micronaut.http.HttpRequest<Map<String,Object>> request)
      Description copied from interface: OauthClient
      Responsible for receiving the authorization callback request and returning an authentication response.
      Specified by:
      onCallback in interface OauthClient
      Parameters:
      request - The callback request
      Returns:
      The authentication response
    • isErrorCallback

      protected boolean isErrorCallback(io.micronaut.core.convert.value.ConvertibleMultiValues<String> responseData)
      Parameters:
      responseData - The response data
      Returns:
      True if the response indicates an error occurred.
    • getTokenEndpoint

      @Deprecated(forRemoval=true) protected SecureEndpoint getTokenEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Not used.
      Returns:
      The token endpoint