Package net.shibboleth.sp.saml.saml2.profile.impl

Class AddLogoutRequest

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.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.AbstractApplicationAction

net.shibboleth.sp.saml.saml2.profile.impl.AddLogoutRequest

All Implemented Interfaces:

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

public class AddLogoutRequest
extends AbstractApplicationAction

Action that creates an LogoutRequest and sets it as the message returned by InOutOperationContext.getOutboundMessageContext().

If an issuer value is returned via a lookup strategy, then it's set as the Issuer of the message.

A SAMLLogoutContext must be present to provide the necessary information to populate into the request.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.IO_ERROR, EventIds.INVALID_MSG_CTX, EventIds.INVALID_PROFILE_CTX, IdPEventIds.INVALID_PROFILE_CONFIG

Precondition:

ProfileRequestContext.getSubcontext(SAMLLogoutContext.class) != null

Postcondition:

ProfileRequestContext.getOutboundMessageContext().getMessage() != null

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 String	issuerId	EntityID to populate into Issuer element.
private Function<ProfileRequestContext,String>	issuerLookupStrategy	Strategy used to obtain the request issuer value.
private org.slf4j.Logger	log	Class logger.
private SAMLLogoutContext	logoutContext	Cached logout context.
private boolean	overwriteExisting	Overwrite an existing message?
private SingleLogoutProfileConfiguration	profileConfiguration	Applicable profile configuration.
private SAMLStateData	stateData	Cached state data object to populate.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextCreationStrategy	Strategy used to create the StateDataContext to populate.

Constructor Summary

Constructors

Constructor	Description
AddLogoutRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
private Extensions	buildExtensions(ProfileRequestContext profileRequestContext)	Build Asynchronous extension if required.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setIssuerLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the issuer value to use.
void	setOverwriteExisting(boolean flag)	Set whether to overwrite an existing message.
void	setStateDataContextCreationStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to create the StateDataContext.

Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

ensureApplication, getApplication

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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, doInitialize, 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 org.slf4j.Logger log

Class logger.

overwriteExisting

private boolean overwriteExisting

Overwrite an existing message?

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

stateDataContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextCreationStrategy

Strategy used to create the StateDataContext to populate.

issuerLookupStrategy

@Nullable
private Function<ProfileRequestContext,String> issuerLookupStrategy

Strategy used to obtain the request issuer value.

idGenerator

@NonnullBeforeExec
private IdentifierGenerationStrategy idGenerator

The generator to use.

profileConfiguration

@NonnullBeforeExec
private SingleLogoutProfileConfiguration profileConfiguration

Applicable profile configuration.

logoutContext

@NonnullBeforeExec
private SAMLLogoutContext logoutContext

Cached logout context.

stateData

@NonnullBeforeExec
private SAMLStateData stateData

Cached state data object to populate.

issuerId

@Nullable
private String issuerId

EntityID to populate into Issuer element.

Constructor Details

AddLogoutRequest

public AddLogoutRequest()

Constructor.

Method Details

setOverwriteExisting

public void setOverwriteExisting(boolean flag)

Set whether to overwrite an existing message.

Parameters:

flag - flag to set

setIdentifierGeneratorLookupStrategy

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

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - lookup strategy

setStateDataContextCreationStrategy

public void setStateDataContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,StateDataContext> strategy)

Sets the strategy used to create the StateDataContext.

Parameters:

strategy - creation strategy

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nullable
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the issuer value to use.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

buildExtensions

@Nullable
private Extensions buildExtensions(@Nonnull
 ProfileRequestContext profileRequestContext)

Build Asynchronous extension if required.

Parameters:

profileRequestContext - current profile request context

Returns:

extension or null