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

Class PrepareAgentResponse

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.profile.AbstractTokenConsumerResponseAction

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

All Implemented Interfaces:

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

public class PrepareAgentResponse
extends AbstractTokenConsumerResponseAction

SAML-specific subclass of token consumer response action.

The base class does all the work, the subclass simply overrides the methods needed to express SAML-specific RelayState and session data behavior.

The session data initially will consist of some serialized opaque blob containing enough information to process logout requests in the future, the SessionIndex and the NameID. In the absence of an identifier, no data is neeeded since logout is impossible, so null can be returned.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
static final String	NAMEID_PARAM	Parameter for accessing NameID from opaque data.
private SAMLTokenContext	samlTokenContext	Context to operate on.
private Function<ProfileRequestContext,SAMLTokenContext>	samlTokenContextLookupStrategy	Strategy used to look up SAMLTokenContext to operate on.

Constructor Summary

Constructors

Constructor	Description
PrepareAgentResponse()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
protected DDF	getSessionData(ProfileRequestContext profileRequestContext)
protected Instant	getSessionNotOnOrAfter(ProfileRequestContext profileRequestContext)
void	setSAMLTokenContextLookupStrategy(Function<ProfileRequestContext,SAMLTokenContext> strategy)	Set the strategy used to return the SAMLTokenContext for input.

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

doExecute, setAttributeContextLookupStrategy, setStateDataContextLookupStrategy

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

NAMEID_PARAM

@Nonnull
@NotEmpty
public static final String NAMEID_PARAM

Parameter for accessing NameID from opaque data.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

samlTokenContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SAMLTokenContext> samlTokenContextLookupStrategy

Strategy used to look up SAMLTokenContext to operate on.

samlTokenContext

@NonnullBeforeExec
private SAMLTokenContext samlTokenContext

Context to operate on.

Constructor Details

PrepareAgentResponse

public PrepareAgentResponse()

Constructor.

Method Details

setSAMLTokenContextLookupStrategy

public void setSAMLTokenContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,SAMLTokenContext> strategy)

Set the strategy used to return the SAMLTokenContext for input.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractTokenConsumerResponseAction

getSessionData

@Nullable
protected DDF getSessionData(@Nonnull
 ProfileRequestContext profileRequestContext)

Specified by:

getSessionData in class AbstractTokenConsumerResponseAction

getSessionNotOnOrAfter

@Nullable
protected Instant getSessionNotOnOrAfter(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

getSessionNotOnOrAfter in class AbstractTokenConsumerResponseAction