org.apache.jetspeed.pipeline
Interface Pipeline

All Known Implementing Classes:
JetspeedPipeline

public interface Pipeline

NOTE: This class will be deprecated once we merge with Summit

Version:
$Id: Pipeline.java 187173 2004-08-01 23:17:25Z weaver $
Author:
David Sean Taylor

Method Summary
 void addValve(Valve valve)
          Add a new Valve to the end of the pipeline.
 Valve[] getValves()
          Return the set of all Valves in the pipeline.
 void initialize()
           
 void invoke(org.apache.jetspeed.request.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

public void initialize()
                throws PipelineException
Throws:
PipelineException

addValve

public void addValve(Valve valve)

Add a new Valve to the end of the pipeline.

Parameters:
valve - Valve to be added.
Throws:
IllegalStateException - If the pipeline has not been initialized.

getValves

public 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.

invoke

public void invoke(org.apache.jetspeed.request.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.

Throws:
IOException - an input/output error occurred.
PipelineException

removeValve

public void removeValve(Valve valve)

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

Parameters:
valve - Valve to be removed.


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.