Package net.shibboleth.sp.profile.impl

Class RecoverPostData

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.impl.RecoverPostData

All Implemented Interfaces:

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

public class RecoverPostData
extends AbstractApplicationAction

Action that detects submitted form data, and when permitted, stores it in a StorageService and issues a cookie associated with the active state token to preserve a pointer to the data for recovery.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MESSAGE, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Precondition:

AgentRequestContext.getOutput().isstruct()

,

AgentRequestContext.getRemotedServletResponse() != null

Field Summary

Fields

Modifier and Type	Field	Description
private CookieManager	cookieManager	Cookie manager.
private String	cookiePrefix	Cookie prefix.
private StringDigester	cspDigester	Digester for CSP hashes.
private IdentifierGenerationStrategy	cspNonceGenerator	CSP nonce generation.
private CharsetDecoder	decoder	Deecoder for Agent data.
static final String	DEFAULT_COOKIE_PREFIX	Default cookie prefix.
static final String	DEFAULT_TEMPLATE_ID	Default template ID.
private org.slf4j.Logger	log	Class logger.
private String	postData	Recovered data.
(package private) byte[]	resource	Target of POST.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextLookupStrategy	Strategy used to locate the StateDataContext to pull target from.
private StorageService	storageService	Storage service for data.
private org.apache.velocity.app.VelocityEngine	velocityEngine	Velocity engine used to evaluate the replay form template.
private String	velocityTemplateId	ID of the velocity template used to generate replay form.

Constructor Summary

Constructors

Constructor	Description
RecoverPostData()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private String	getRecoveredData()	Checks for stored data based on the state token and cookie(s) supplied and reads back from storage, deleting the record.
void	setCookieManager(CookieManager manager)	Sets the CookieManager to use.
void	setCookiePrefix(String prefix)	Sets the cookie prefix.
void	setCSPDigester(StringDigester digester)	Set a StringDigester to use to generate CSP hashes.
void	setCSPNonceGenerator(IdentifierGenerationStrategy strategy)	Set IdentifierGenerationStrategy to use for generating CSP nonces.
void	setStateDataContextLookupStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to lookup the StateDataContext.
void	setStorageService(StorageService storage)	Set StorageService to use.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine newVelocityEngine)	Set the VelocityEngine instance.
void	setVelocityTemplateId(String newVelocityTemplateId)	Set the Velocity template ID.

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, 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

DEFAULT_TEMPLATE_ID

@Nonnull
@NotEmpty
public static final String DEFAULT_TEMPLATE_ID

Default template ID.

See Also:

• Constant Field Values

DEFAULT_COOKIE_PREFIX

@Nonnull
@NotEmpty
public static final String DEFAULT_COOKIE_PREFIX

Default cookie prefix.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

velocityEngine

@NonnullAfterInit
private org.apache.velocity.app.VelocityEngine velocityEngine

Velocity engine used to evaluate the replay form template.

velocityTemplateId

@NonnullAfterInit
private String velocityTemplateId

ID of the velocity template used to generate replay form.

cspDigester

@Nullable
private StringDigester cspDigester

Digester for CSP hashes.

cspNonceGenerator

@Nullable
private IdentifierGenerationStrategy cspNonceGenerator

CSP nonce generation.

storageService

@NonnullAfterInit
private StorageService storageService

Storage service for data.

cookieManager

@NonnullAfterInit
private CookieManager cookieManager

Cookie manager.

cookiePrefix

@Nonnull
private String cookiePrefix

Cookie prefix.

stateDataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy

Strategy used to locate the StateDataContext to pull target from.

decoder

@NonnullBeforeExec
private CharsetDecoder decoder

Deecoder for Agent data.

postData

@NonnullBeforeExec
private String postData

Recovered data.

resource

@NonnullBeforeExec
byte[] resource

Target of POST.

Constructor Details

RecoverPostData

public RecoverPostData()

Constructor.

Method Details

setVelocityEngine

public void setVelocityEngine(@Nullable
 org.apache.velocity.app.VelocityEngine newVelocityEngine)

Set the VelocityEngine instance.

Parameters:

newVelocityEngine - the new VelocityEngine instane

setVelocityTemplateId

public void setVelocityTemplateId(@Nullable
 String newVelocityTemplateId)

Set the Velocity template ID.

Defaults to DEFAULT_TEMPLATE_ID.

Parameters:

newVelocityTemplateId - the new Velocity template id

setCSPDigester

public void setCSPDigester(@Nullable
 StringDigester digester)

Set a StringDigester to use to generate CSP hashes.

Parameters:

digester - string digester

setCSPNonceGenerator

public void setCSPNonceGenerator(@Nullable
 IdentifierGenerationStrategy strategy)

Set IdentifierGenerationStrategy to use for generating CSP nonces.

Parameters:

strategy - nonce generator strategy

setStorageService

public void setStorageService(@Nonnull
 StorageService storage)

Set StorageService to use.

Parameters:

storage - storage service

setCookieManager

public void setCookieManager(@Nonnull
 CookieManager manager)

Sets the CookieManager to use.

Parameters:

manager - cookie manager instance

setCookiePrefix

public void setCookiePrefix(@Nonnull @NotEmpty
 String prefix)

Sets the cookie prefix.

Defaults to DEFAULT_COOKIE_PREFIX.

Parameters:

prefix - cookie prefix

setStateDataContextLookupStrategy

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

Sets the strategy used to lookup the StateDataContext.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

getRecoveredData

@Nullable
private String getRecoveredData()

Checks for stored data based on the state token and cookie(s) supplied and reads back from storage, deleting the record.

Errors here are logged and suppressed since there's nothing to be done about them.

Returns:

recovered data, if any