io.micronaut.security.oauth2.endpoint.endsession.request

Class AbstractEndSessionRequest

java.lang.Object

io.micronaut.security.oauth2.endpoint.endsession.request.AbstractEndSessionRequest

All Implemented Interfaces:

EndSessionEndpoint

Direct Known Subclasses:

Auth0EndSessionEndpoint, AwsCognitoEndSessionEndpoint, OktaEndSessionEndpoint

public abstract class AbstractEndSessionRequest
extends java.lang.Object
implements EndSessionEndpoint

A base class to extend from to log out of an OpenID provider.

Since:

1.2.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field and Description
protected OauthClientConfiguration	clientConfiguration
protected EndSessionCallbackUrlBuilder	endSessionCallbackUrlBuilder
protected OpenIdProviderMetadata	providerMetadata Deprecated. Use providerMetadataSupplier instead.
protected java.util.function.Supplier<OpenIdProviderMetadata>	providerMetadataSupplier

Constructor Summary

Constructors

Constructor and Description
AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder, OauthClientConfiguration clientConfiguration, OpenIdProviderMetadata providerMetadata) Deprecated. Use AbstractEndSessionRequest(EndSessionCallbackUrlBuilder, OauthClientConfiguration, Supplier) instead.
AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder, OauthClientConfiguration clientConfiguration, java.util.function.Supplier<OpenIdProviderMetadata> providerMetadata)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getArguments(io.micronaut.http.HttpRequest originating, Authentication authentication)
protected java.lang.String	getRedirectUri(io.micronaut.http.HttpRequest originating)
protected abstract java.lang.String	getUrl()
java.lang.String	getUrl(io.micronaut.http.HttpRequest originating, Authentication authentication)

Methods inherited from class java.lang.Object

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

Field Detail

endSessionCallbackUrlBuilder

protected final EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder

clientConfiguration

protected final OauthClientConfiguration clientConfiguration

providerMetadata

@Deprecated
protected final OpenIdProviderMetadata providerMetadata

Deprecated. Use providerMetadataSupplier instead.

providerMetadataSupplier

protected final java.util.function.Supplier<OpenIdProviderMetadata> providerMetadataSupplier

Constructor Detail

AbstractEndSessionRequest

@Deprecated
public AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder,
                                             OauthClientConfiguration clientConfiguration,
                                             OpenIdProviderMetadata providerMetadata)

Deprecated. Use AbstractEndSessionRequest(EndSessionCallbackUrlBuilder, OauthClientConfiguration, Supplier) instead.

Parameters:

endSessionCallbackUrlBuilder - The end session callback URL builder

clientConfiguration - The client configuration

providerMetadata - The provider metadata

AbstractEndSessionRequest

public AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder,
                                 OauthClientConfiguration clientConfiguration,
                                 java.util.function.Supplier<OpenIdProviderMetadata> providerMetadata)

Parameters:

endSessionCallbackUrlBuilder - The end session callback URL builder

clientConfiguration - The client configuration

providerMetadata - The provider metadata supplier

Method Detail

getUrl

@Nullable
public java.lang.String getUrl(io.micronaut.http.HttpRequest originating,
                                         Authentication authentication)

Specified by:

getUrl in interface EndSessionEndpoint

Parameters:

originating - The Originating HTTP Request

authentication - The authentication.

Returns:

The OpenID provider end session URL.

getUrl

protected abstract java.lang.String getUrl()

Returns:

The url of the request

getArguments

protected abstract java.util.Map<java.lang.String,java.lang.Object> getArguments(io.micronaut.http.HttpRequest originating,
                                                                                 Authentication authentication)

Parameters:

originating - The originating request

authentication - The authentication

Returns:

The parameters to include in the URL

getRedirectUri

protected java.lang.String getRedirectUri(io.micronaut.http.HttpRequest originating)

Parameters:

originating - The originating request

Returns:

The absolute redirect URI