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

Class PrepareBackChannelLogoutRequest

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.PrepareBackChannelLogoutRequest

All Implemented Interfaces:

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

public class PrepareBackChannelLogoutRequest
extends AbstractOIDCBackChannelLogoutPropagationAction

An action that constructs LogoutTokenClaimsSet and attaches it to the OIDCBackChannelLogoutPropagationContext.

Field Summary

Fields

Modifier and Type	Field	Description
private IdentifierGenerationStrategy	idGenerator	The generator to use.
private Function<ProfileRequestContext,IdentifierGenerationStrategy>	idGeneratorLookupStrategy	Strategy used to locate the IdentifierGenerationStrategy to use.
private static final org.slf4j.Logger	log	Class logger.
private Duration	logoutTokenExpiryOffset	The offset to add to the 'exp' claim time for logout token claims set.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper	Object mapper used for pretty-printing logout token contents.
private org.slf4j.Logger	protocolMessageLog	Used to log protocol messages.
private boolean	xmlSafeIdentifier	The xmlSafe-flag passed to the identifier generator.

Constructor Summary

Constructors

Constructor	Description
PrepareBackChannelLogoutRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setLogoutTokenExpiryOffset(Duration expiry)	Set the logout token expiry time offset.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	Set the object mapper used for pretty-printing logout token contents.
void	setXmlSafeIdentifier(boolean flag)	Set the xmlSafe-flag passed to the identifier generator

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 static final org.slf4j.Logger log

Class logger.

protocolMessageLog

@Nonnull
private org.slf4j.Logger protocolMessageLog

Used to log protocol messages.

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

objectMapper

@NonnullAfterInit
private com.fasterxml.jackson.databind.ObjectMapper objectMapper

Object mapper used for pretty-printing logout token contents.

idGenerator

@Nullable
private IdentifierGenerationStrategy idGenerator

The generator to use.

xmlSafeIdentifier

private boolean xmlSafeIdentifier

The xmlSafe-flag passed to the identifier generator.

logoutTokenExpiryOffset

@Nonnull
private Duration logoutTokenExpiryOffset

The offset to add to the 'exp' claim time for logout token claims set. Default is 30 seconds.

Constructor Details

PrepareBackChannelLogoutRequest

public PrepareBackChannelLogoutRequest()

Constructor.

Method Details

setIdentifierGeneratorLookupStrategy

public void setIdentifierGeneratorLookupStrategy(@Nonnull
 Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - lookup strategy

setXmlSafeIdentifier

public void setXmlSafeIdentifier(boolean flag)

Set the xmlSafe-flag passed to the identifier generator

Parameters:

flag - xmlSafe-flag

setObjectMapper

public void setObjectMapper(@Nonnull
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Set the object mapper used for pretty-printing logout token contents.

Parameters:

mapper - What to set.

setLogoutTokenExpiryOffset

public void setLogoutTokenExpiryOffset(@Nonnull
 Duration expiry)

Set the logout token expiry time offset.

Parameters:

expiry - the logout token 'exp' claim offset

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