org.opensaml.messaging.handler.impl

Class BasicMessageHandlerChain<MessageType>

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler<MessageType>

org.opensaml.messaging.handler.impl.BasicMessageHandlerChain<MessageType>

Type Parameters:

MessageType - the type of message being handled

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MessageHandler<MessageType>, MessageHandlerChain<MessageType>

public class BasicMessageHandlerChain<MessageType>
extends AbstractMessageHandler<MessageType>
implements MessageHandlerChain<MessageType>

A basic implementation of MessageHandlerChain.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MessageHandler<MessageType>>	members The list of members of the handler chain.

Constructor Summary

Constructors

Constructor and Description
BasicMessageHandlerChain()

Method Summary

Modifier and Type	Method and Description
void	doInvoke(MessageContext<MessageType> msgContext) Performs the handler logic.
java.util.List<MessageHandler<MessageType>>	getHandlers() Get the ordered list of message handlers which comprise the handler chain.
void	setHandlers(java.util.List<MessageHandler<MessageType>> handlers) Set the list of message handler chain members.

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

doPostInvoke, doPostInvoke, doPreInvoke, getLogPrefix, invoke

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 org.opensaml.messaging.handler.MessageHandler

invoke

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

members

@NonnullAfterInit
 @NonnullElements
private java.util.List<MessageHandler<MessageType>> members

The list of members of the handler chain.

Constructor Detail

BasicMessageHandlerChain

public BasicMessageHandlerChain()

Method Detail

getHandlers

@NonnullAfterInit
 @NonnullElements
public java.util.List<MessageHandler<MessageType>> getHandlers()

Get the ordered list of message handlers which comprise the handler chain.

The returned list is immutable. Changes to the list should be accomplished through setHandlers(List).

Specified by:

getHandlers in interface MessageHandlerChain<MessageType>

Returns:

the list of members of the handler chain

setHandlers

public void setHandlers(@Nullable @NonnullElements
                        java.util.List<MessageHandler<MessageType>> handlers)

Set the list of message handler chain members.

The supplied list is copied before being stored. Later modifications to the originally supplied list will not be reflected in the handler chain membership.

Parameters:

handlers - the list of message handler members

doInvoke

public void doInvoke(@Nonnull
                     MessageContext<MessageType> msgContext)
              throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler<MessageType>

Parameters:

msgContext - the message context on which to invoke the handler

Throws:

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