Package net.shibboleth.sp.profile.impl

Class CreateOutputMessage

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

All Implemented Interfaces:

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

public class CreateOutputMessage
extends AbstractAgentRequestAction

A profile action to build the "shell" of an Agent response (a DDF), optionally including the RemotedHttpServletResponse.STRUCTURE_NAME member and wrapped response facade to leave subsequent actions with a consistent state to operate on.

As a side effect, this action uses its base class to ensure that the containing AgentRequestContext is also created.

Event:

EventIds.PROCEED_EVENT_ID

Postcondition:

AgentRequestContext.getOutput().isstruct()

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	createServletResponse	Whether to create the remoted servlet response wrapper.
private boolean	overwriteExisting	Whether to replace an existing output message if one exists.

Constructor Summary

Constructors

Constructor	Description
CreateOutputMessage()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
void	setCreateServletResponse(boolean flag)	Sets whether to create the remoted servlet response wrapper.
void	setOverwriteExisting(boolean flag)	Sets whether to replace an existing output message if one exists.

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

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

overwriteExisting

private boolean overwriteExisting

Whether to replace an existing output message if one exists.

createServletResponse

private boolean createServletResponse

Whether to create the remoted servlet response wrapper.

Constructor Details

CreateOutputMessage

public CreateOutputMessage()

Constructor.

Method Details

setOverwriteExisting

public void setOverwriteExisting(boolean flag)

Sets whether to replace an existing output message if one exists.

This also applies to the remoted servlet response wrapper if that option is enabled.

Defaults to false.

Parameters:

flag - flag to set

setCreateServletResponse

public void setCreateServletResponse(boolean flag)

Sets whether to create the remoted servlet response wrapper.

Defaults to false.

Parameters:

flag - flag to set

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction