Package net.shibboleth.sp.profile.impl

Class DecodeAgentRequest

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

All Implemented Interfaces:

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

public class DecodeAgentRequest
extends AbstractAgentAction

A profile action to decode an agent request and stash the resulting DDF in the AgentRequestContext.

The MIME type in the request is used to determine what form of parsing and deserialization to use. The only supported type at present is "text/plain" representing a record-oriented syntax.

If the input message is a structure containing an "http" member, then a wrapped HttpServletRequest object backed by the input message is constructed and stored in the AgentRequestContext.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE

Postcondition:

ProfileRequestContext.ensureSubcontext(AgentRequestContext.class).getInput() != null

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID_MDC_ATTRIBUTE	MDC attribute name for application ID.
private final org.slf4j.Logger	log	Class logger.
private boolean	populateMDC	Whether to populate the MDC.
static final String	TX_ID_MDC_ATTRIBUTE	MDC attribute name for transaction ID.

Constructor Summary

Constructors

Constructor	Description
DecodeAgentRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
void	setPopulateMDC(boolean flag)	Sets whether to populate the application and tx IDs into the logging MDC.

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

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

APPLICATION_ID_MDC_ATTRIBUTE

@Nonnull
@NotEmpty
public static final String APPLICATION_ID_MDC_ATTRIBUTE

MDC attribute name for application ID.

See Also:

• Constant Field Values

TX_ID_MDC_ATTRIBUTE

@Nonnull
@NotEmpty
public static final String TX_ID_MDC_ATTRIBUTE

MDC attribute name for transaction ID.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

populateMDC

private boolean populateMDC

Whether to populate the MDC.

Constructor Details

DecodeAgentRequest

public DecodeAgentRequest()

Constructor.

Method Details

setPopulateMDC

public void setPopulateMDC(boolean flag)

Sets whether to populate the application and tx IDs into the logging MDC.

Defaults to true.

Parameters:

flag - flag to set

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction