org.apache.portals.applications.webcontent2.proxy.impl

Class ProxyProcessingChain

java.lang.Object

org.apache.commons.chain.impl.ChainBase

org.apache.portals.applications.webcontent2.proxy.impl.ProxyProcessingChain

All Implemented Interfaces:

org.apache.commons.chain.Chain, org.apache.commons.chain.Command

public class ProxyProcessingChain
extends org.apache.commons.chain.impl.ChainBase

Convenience base class for reverse proxy processing Chain implementation.

Field Summary

Fields inherited from class org.apache.commons.chain.impl.ChainBase

commands, frozen

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
ProxyProcessingChain() Constructs a ProxyProcessingChain with no configured Commands.
ProxyProcessingChain(Collection commands) Constructs a ProxyProcessingChain configured with the specified Commands.
ProxyProcessingChain(org.apache.commons.chain.Command command) Constructs a ProxyProcessingChain configured with the specified Command.
ProxyProcessingChain(org.apache.commons.chain.Command[] commands) Constructs a ProxyProcessingChain configured with the specified Commands.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommand(int index, org.apache.commons.chain.Command command) Add a Command at the given index of the list of Commands that will be called in turn when this Chain's execute() method is called.
boolean	execute(org.apache.commons.chain.Context context)
List<AbstractProxyCommand>	getAllProxyCommands() Return a list including all the descendant Commands, type of which is AbstractProxyCommand in this proxy processing chain.
org.apache.commons.chain.Command	getCommand(int index) Finds and returns the Command at the given index of the Command list.
int	getCommandCount() Return the size of the internal Command list.
int	getCommandIndex(Class<? extends org.apache.commons.chain.Command> commandType) Return the index of the given class type of Command in the command list.
int	getCommandIndex(org.apache.commons.chain.Command command) Return the index of the given Command in the command list.
boolean	removeCommand(org.apache.commons.chain.Command command) Remove the Command from the list of Commands that will be called in turn when this Chain's execute() method is called.
boolean	removeCommand(int index) Remove the Command at the given index of the list of Commands that will be called in turn when this Chain's execute() method is called.

Methods inherited from class org.apache.commons.chain.impl.ChainBase

addCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProxyProcessingChain

public ProxyProcessingChain()

Constructs a ProxyProcessingChain with no configured Commands.

ProxyProcessingChain

public ProxyProcessingChain(org.apache.commons.chain.Command command)

Constructs a ProxyProcessingChain configured with the specified Command.

Parameters:

command -

ProxyProcessingChain

public ProxyProcessingChain(org.apache.commons.chain.Command[] commands)

Constructs a ProxyProcessingChain configured with the specified Commands.

Parameters:

commands -

ProxyProcessingChain

public ProxyProcessingChain(Collection commands)

Constructs a ProxyProcessingChain configured with the specified Commands.

Parameters:

commands -

Method Detail

getCommandCount

public int getCommandCount()

Return the size of the internal Command list.

Returns:

getCommandIndex

public int getCommandIndex(org.apache.commons.chain.Command command)

Return the index of the given Command in the command list. If not found, it should return -1.

Parameters:

command -

Returns:

getCommandIndex

public int getCommandIndex(Class<? extends org.apache.commons.chain.Command> commandType)

Return the index of the given class type of Command in the command list. If not found, it should return -1.

Parameters:

commandType -

Returns:

getCommand

public org.apache.commons.chain.Command getCommand(int index)

Finds and returns the Command at the given index of the Command list.

Parameters:

index -

Returns:

addCommand

public void addCommand(int index,
              org.apache.commons.chain.Command command)

Add a Command at the given index of the list of Commands that will be called in turn when this Chain's execute() method is called. Once execute() has been called at least once, it is no longer possible to add additional Commands; instead, an exception will be thrown.

Parameters:

index - The index at which the command should be inserted

command - The Command to be added

Throws:

IllegalArgumentException - if command is null, or index is negative or greater than the size of the command list.

IllegalStateException - if this Chain has already been executed at least once, so no further configuration is allowed

removeCommand

public boolean removeCommand(int index)

Remove the Command at the given index of the list of Commands that will be called in turn when this Chain's execute() method is called. Once execute() has been called at least once, it is no longer possible to add additional Commands; instead, an exception will be thrown.

Parameters:

index - The index to add in the command list

Returns:

true if successfully removed.

Throws:

IllegalArgumentException - if index is out of bound.

IllegalStateException - if this Chain has already been executed at least once, so no further configuration is allowed

removeCommand

public boolean removeCommand(org.apache.commons.chain.Command command)

Remove the Command from the list of Commands that will be called in turn when this Chain's execute() method is called. Once execute() has been called at least once, it is no longer possible to add additional Commands; instead, an exception will be thrown.

Parameters:

command - The Command to be added

Returns:

true if successfully removed.

Throws:

IllegalArgumentException - if index is out of bound.

IllegalStateException - if this Chain has already been executed at least once, so no further configuration is allowed

execute

public boolean execute(org.apache.commons.chain.Context context)
                throws ReverseProxyException,
                       IOException

Note: The method implementation takes the strategy to catch all the exceptions thrown while executing commands in the chain in order to proceed to the next commands even when a command throws an exception in an earlier step. This guarantees each of the internal commands are always to execute. So, for example, a command, which is responsible for cleaning up all the resources used during the reverse proxy processing, will always have a chance to do its job in this reverse proxy processing chain.

Specified by:

execute in interface org.apache.commons.chain.Chain

Specified by:

execute in interface org.apache.commons.chain.Command

Overrides:

execute in class org.apache.commons.chain.impl.ChainBase

Throws:

ReverseProxyException

IOException

getAllProxyCommands

public List<AbstractProxyCommand> getAllProxyCommands()

Return a list including all the descendant Commands, type of which is AbstractProxyCommand in this proxy processing chain.

Returns: