net.shibboleth.idp.saml.profile.impl

Class InitializeOutboundMessageContextForError

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.saml.profile.impl.InitializeOutboundMessageContextForError

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class InitializeOutboundMessageContextForError
extends AbstractProfileAction

Action that prepares an outbound MessageContext and related SAML contexts in the event that they are not already prepared, to allow error responses to be generated in the case of synchronous bindings (i.e., SOAP).

This is a "make-up" action that fills in missing information that may not have been populated in the course of normal processing, if an error occurs early in profile processing. It does nothing if an outbound message context already exists.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MSG_CTX

Postcondition:

ProfileRequestContext.getOutboundMessageContext() != null

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLBindingContext>	bindingContextLookupStrategy Strategy function for access to SAMLBindingContext to populate.
private org.slf4j.Logger	log Class logger.
private String	outboundBinding Outbound binding to use.
private org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext	peerEntityCtx The SAMLPeerEntityContext to base the outbound context on, if any.
private Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy Relying party context lookup strategy.

Constructor Summary

Constructors

Constructor and Description
InitializeOutboundMessageContextForError() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setBindingContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLBindingContext> strategy) Set lookup strategy for SAMLBindingContext to populate.
void	setOutboundBinding(String binding) Set the outbound binding to use for the error response.
void	setRelyingPartyContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyContext> strategy) Set the relying party context lookup strategy.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getMessage, getMessage, getMessage, 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, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

bindingContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLBindingContext> bindingContextLookupStrategy

Strategy function for access to SAMLBindingContext to populate.

relyingPartyContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Relying party context lookup strategy.

outboundBinding

@NonnullAfterInit
private String outboundBinding

Outbound binding to use.

peerEntityCtx

@Nullable
private org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext peerEntityCtx

The SAMLPeerEntityContext to base the outbound context on, if any.

Constructor Detail

InitializeOutboundMessageContextForError

public InitializeOutboundMessageContextForError()

Constructor.

Method Detail

setBindingContextLookupStrategy

public void setBindingContextLookupStrategy(@Nonnull
                                   Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLBindingContext> strategy)

Set lookup strategy for SAMLBindingContext to populate.

Parameters:

strategy - lookup strategy

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
                                        Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyContext> strategy)

Set the relying party context lookup strategy.

Parameters:

strategy - lookup strategy

setOutboundBinding

public void setOutboundBinding(@Nonnull@NotEmpty
                      String binding)

Set the outbound binding to use for the error response.

Parameters:

binding - binding identifier

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction