org.apache.jetspeed.pipeline
Interface Pipeline

public interface Pipeline

Jetspeed Pipeline

Version:

$Id: Pipeline.java 892528 2009-12-19 23:20:32Z rwatler $

Author:

David Sean Taylor

Method Summary

void	addValve(Valve valve) Add a new Valve to the end of the pipeline.
Valve[]	getCleanupValves() Return the set of all cleanup Valves in the pipeline.
java.lang.String	getName() Get the name of the pipeine
Valve[]	getValves() Return the set of all Valves in the pipeline.
void	initialize()
void	invoke(RequestContext context) Cause the specified request and response to be processed by the sequence of Valves associated with this pipeline, until one of these Valves decides to end the processing.
void	removeValve(Valve valve) Remove the specified Valve from the pipeline, if it is found; otherwise, do nothing.

Method Detail

initialize

void initialize()
                throws PipelineException

Throws:

PipelineException

addValve

void addValve(Valve valve)

Add a new Valve to the end of the pipeline.

Parameters:

valve - Valve to be added.

Throws:

java.lang.IllegalStateException - If the pipeline has not been initialized.

getValves

Valve[] getValves()

Return the set of all Valves in the pipeline. If there are no such Valves, a zero-length array is returned.

Returns:

An array of valves.

getCleanupValves

Valve[] getCleanupValves()

Return the set of all cleanup Valves in the pipeline. If there are no such Valves, a zero-length array is returned.

Returns:

An array of cleanup valves.

invoke

void invoke(RequestContext context)
            throws PipelineException

Cause the specified request and response to be processed by the sequence of Valves associated with this pipeline, until one of these Valves decides to end the processing.

The implementation must ensure that multiple simultaneous requests (on different threads) can be processed through the same Pipeline without interfering with each other's control flow.

Parameters:

data - The run-time information, including the servlet request and response we are processing.

Throws:

java.io.IOException - an input/output error occurred.

PipelineException

removeValve

void removeValve(Valve valve)

Remove the specified Valve from the pipeline, if it is found; otherwise, do nothing.

Parameters:

valve - Valve to be removed.

getName

java.lang.String getName()

Get the name of the pipeine

Returns:

name of the pipeline