Package 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, KeycloakEndSessionEndpoint, OktaEndSessionEndpoint

public abstract class AbstractEndSessionRequest
extends 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	Description
protected final OauthClientConfiguration	clientConfiguration
protected final EndSessionCallbackUrlBuilder	endSessionCallbackUrlBuilder
protected final Supplier<OpenIdProviderMetadata>	providerMetadataSupplier

Constructor Summary

Constructors

Constructor	Description
AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder, OauthClientConfiguration clientConfiguration, Supplier<OpenIdProviderMetadata> providerMetadata)

Method Summary

Modifier and Type	Method	Description
protected abstract Map<String,Object>	getArguments(io.micronaut.http.HttpRequest<?> originating, Authentication authentication)
protected String	getRedirectUri(io.micronaut.http.HttpRequest<?> originating)
protected abstract String	getUrl()
@Nullable 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 Details

endSessionCallbackUrlBuilder

protected final EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder

clientConfiguration

protected final OauthClientConfiguration clientConfiguration

providerMetadataSupplier

protected final Supplier<OpenIdProviderMetadata> providerMetadataSupplier

Constructor Details

AbstractEndSessionRequest

public AbstractEndSessionRequest(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder,
 OauthClientConfiguration clientConfiguration,
 Supplier<OpenIdProviderMetadata> providerMetadata)

Parameters:

endSessionCallbackUrlBuilder - The end session callback URL builder

clientConfiguration - The client configuration

providerMetadata - The provider metadata supplier

Method Details

getUrl

@Nullable
public @Nullable 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 String getUrl()

Returns:

The url of the request

getArguments

protected abstract Map<String,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 String getRedirectUri(io.micronaut.http.HttpRequest<?> originating)

Parameters:

originating - The originating request

Returns:

The absolute redirect URI