org.opensaml.ws.message.handler
Interface PhasedHandlerChain

All Superinterfaces:

HandlerChain

All Known Implementing Classes:

BasicPhasedHandlerChain

public interface PhasedHandlerChain
extends HandlerChain

A specialized type of HandlerChain which supports organizing multiple handler chains into a set of named handler chains called 'phases', which will be invoked in a specified order.

Method Summary

List<Handler>	getHandlers() Get the complete effective list of ordered handlers in the handler chain.
Map<String,HandlerChain>	getPhaseChains() Modifiable map of phase names to corresponding handler chains.
List<String>	getPhaseOrder() Get the order of phase invocation.
void	setPhaseOrder(List<String> newPhaseOrder) Set the order of phase invocation.

Methods inherited from interface org.opensaml.ws.message.handler.HandlerChain

invoke

Method Detail

getPhaseChains

Map<String,HandlerChain> getPhaseChains()

Modifiable map of phase names to corresponding handler chains.

Returns:

the map of phase names to handler chains

getPhaseOrder

List<String> getPhaseOrder()

Get the order of phase invocation. Handler chains will be invoked in the order determined by this list.

Returns:

the ordered list of phase names

setPhaseOrder

void setPhaseOrder(List<String> newPhaseOrder)

Set the order of phase invocation. Handler chains will be invoked in the order determined by this list.

Parameters:

newPhaseOrder - a list of phase names

getHandlers

List<Handler> getHandlers()

Get the complete effective list of ordered handlers in the handler chain.

Note that unlike HandlerChain, the returned list is NOTmodifiable. Handler instances in the effective chain should be added and removed via membership in the appropriate handler chain phase, obtained via getPhaseChains().

Specified by:

getHandlers in interface HandlerChain

Returns:

list of handlers