Package net.shibboleth.idp.plugin.oidc.op.logout.profile.impl

Class ExecuteBackChannelLogoutRequest

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCResponseAction

net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.AbstractOIDCLogoutPropagationAction

net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.AbstractOIDCBackChannelLogoutPropagationAction

net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.ExecuteBackChannelLogoutRequest

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class ExecuteBackChannelLogoutRequest
extends AbstractOIDCBackChannelLogoutPropagationAction

An action that executes the OIDC back-channel logout request and sets the result via LogoutPropagationContext.setResult(net.shibboleth.idp.session.context.LogoutPropagationContext.Result).

Field Summary

Fields

Modifier and Type	Field	Description
private URI	backChannelLogoutURI	The back-channel logout URI for which to send the back-channel logout request.
private org.apache.hc.client5.http.classic.HttpClient	httpClient	HTTP Client used to post the data.
private HttpClientSecurityParameters	httpClientSecurityParameters	HTTP client security parameters.
private final org.slf4j.Logger	log	Class logger.
private JWT	logoutToken	The back-channel logout token.
private final Function<OIDCClientInformation,String>	oidcBackChannelLogoutURILookupFunction	The lookup strategy for back-channel logout endpoint.

Constructor Summary

Constructors

Constructor	Description
ExecuteBackChannelLogoutRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
private org.apache.hc.client5.http.protocol.HttpClientContext	buildHttpContext(org.apache.hc.client5.http.classic.methods.HttpUriRequest request)	Build the HttpClientContext instance to be used by the HttpClient.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setHttpClient(org.apache.hc.client5.http.classic.HttpClient client)	Set the HttpClient to use.
void	setHttpClientSecurityParameters(HttpClientSecurityParameters params)	Set the optional client security parameters.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.AbstractOIDCBackChannelLogoutPropagationAction

getOidcBackChannelLogoutContext

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.AbstractOIDCLogoutPropagationAction

getLogoutPropagationContext, getOidcLogoutContext, getOidcRPSession, setLogoutPropagationContextLookupStrategy

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCResponseAction

getMetadataContext, getOidcResponseContext

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

httpClient

@NonnullAfterInit
private org.apache.hc.client5.http.classic.HttpClient httpClient

HTTP Client used to post the data.

httpClientSecurityParameters

@Nullable
private HttpClientSecurityParameters httpClientSecurityParameters

HTTP client security parameters.

oidcBackChannelLogoutURILookupFunction

@Nonnull
private final Function<OIDCClientInformation,String> oidcBackChannelLogoutURILookupFunction

The lookup strategy for back-channel logout endpoint.

backChannelLogoutURI

@Nullable
private URI backChannelLogoutURI

The back-channel logout URI for which to send the back-channel logout request.

logoutToken

@Nullable
private JWT logoutToken

The back-channel logout token.

Constructor Details

ExecuteBackChannelLogoutRequest

public ExecuteBackChannelLogoutRequest()

Constructor.

Method Details

setHttpClient

public void setHttpClient(@Nonnull
 org.apache.hc.client5.http.classic.HttpClient client)

Set the HttpClient to use.

Parameters:

client - What to set

setHttpClientSecurityParameters

public void setHttpClientSecurityParameters(@Nullable
 HttpClientSecurityParameters params)

Set the optional client security parameters.

Parameters:

params - What to set

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOIDCBackChannelLogoutPropagationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

buildHttpContext

@Nonnull
private org.apache.hc.client5.http.protocol.HttpClientContext buildHttpContext(@Nonnull
 org.apache.hc.client5.http.classic.methods.HttpUriRequest request)

Build the HttpClientContext instance to be used by the HttpClient.

Parameters:

request - the HTTP client request

Returns:

the client context instance