Package org.opensaml.saml.common.binding.impl

Class AddChannelBindingsHeaderHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.impl.AddChannelBindingsHeaderHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class AddChannelBindingsHeaderHandler
extends AbstractMessageHandler

MessageHandler to add ChannelBindings headers to an outgoing SOAP envelope.

Field Summary

Fields

Modifier and Type	Field	Description
private ChannelBindingsContext	channelBindingsContext	The ChannelBindingsContext to operate on.
private Function<MessageContext,ChannelBindingsContext>	channelBindingsContextLookupStrategy	Strategy used to locate the ChannelBindingsContext to operate on.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
AddChannelBindingsHeaderHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInvoke(MessageContext messageContext)	Performs the handler logic.
protected boolean	doPreInvoke(MessageContext messageContext)	Called prior to execution, handlers may override this method to perform pre-processing for a request.
void	setChannelBindingsContextLookupStrategy(Function<MessageContext,ChannelBindingsContext> strategy)	Set the strategy used to locate the ChannelBindingsContext to operate on.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

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

destroy, doDestroy, doInitialize, 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 Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

channelBindingsContextLookupStrategy

@Nonnull
private Function<MessageContext,ChannelBindingsContext> channelBindingsContextLookupStrategy

Strategy used to locate the ChannelBindingsContext to operate on.

channelBindingsContext

@Nullable
private ChannelBindingsContext channelBindingsContext

The ChannelBindingsContext to operate on.

Constructor Details

AddChannelBindingsHeaderHandler

public AddChannelBindingsHeaderHandler()

Constructor.

Method Details

setChannelBindingsContextLookupStrategy

public void setChannelBindingsContextLookupStrategy(@Nonnull
 Function<MessageContext,ChannelBindingsContext> strategy)

Set the strategy used to locate the ChannelBindingsContext to operate on.

Parameters:

strategy - lookup strategy

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Called prior to execution, handlers may override this method to perform pre-processing for a request.

The default impl applies the Predicate set via the AbstractMessageHandler.setActivationCondition(Predicate).

If false is returned, execution will not proceed.

Subclasses which override this method should generally invoke the super version of this method first, so that the activation condition will be applied up front, and immediately return false if the super version returns false. This avoids unnecessary execution of the remaining pre-invocation code if the handler ultimately will not execute.

Overrides:

doPreInvoke in class AbstractMessageHandler

Parameters:

messageContext - the message context on which to invoke the handler

Returns:

true iff execution should proceed

Throws:

MessageHandlerException - if there is a problem executing the handler pre-routine

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler

Parameters:

messageContext - the message context on which to invoke the handler

Throws:

MessageHandlerException - if there is an error invoking the handler on the message context