org.apache.jetspeed.pipeline
Class JetspeedPipeline

java.lang.Object
  org.apache.jetspeed.pipeline.JetspeedPipeline

All Implemented Interfaces:

Pipeline, ValveContext

public class JetspeedPipeline

extends Object

implements Pipeline, ValveContext

Flexible implementation of a Pipeline.

Suggested order of valves:

• ContainerValve
• CapabilityValve
• UserProfilerValve
• PageProfilerValve
• ActionValve
• LayoutValve
• ContentValve
• AggregateValve
• CleanupValve

Version:

$Id: JetspeedPipeline.java 188451 2005-03-27 21:38:32Z ate $

Author:

Jason van Zyl, David Sean Taylor

Field Summary

private org.apache.commons.logging.Log	log Logger
protected String	name Name of this pipeline.
protected ThreadLocal	state The per-thread execution state for processing through this pipeline.
protected Valve[]	valves The set of Valves associated with this Pipeline.

Constructor Summary

JetspeedPipeline(String name, List valveList)
Constructor that provides the descriptor for building the pipeline

Method Summary

void	addValve(Valve valve) Add a new Valve to the end of the pipeline.
String	getName() Get the name of this pipeline.
Valve[]	getValves() Return the set of all Valves in the pipeline.
void	initialize()
void	invoke(org.apache.jetspeed.request.RequestContext request) 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	invokeNext(org.apache.jetspeed.request.RequestContext request) Cause the invoke() method of the next Valve that is part of the Pipeline currently being processed (if any) to be executed, passing on the specified request and response objects plus this ValveContext instance.
void	removeValve(Valve valve) Remove the specified Valve from the pipeline, if it is found; otherwise, do nothing.
void	setName(String name) Set the name of this pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

log

private org.apache.commons.logging.Log log

Logger

name

protected String name

Name of this pipeline.

valves

protected Valve[] valves

The set of Valves associated with this Pipeline.

state

protected ThreadLocal state

The per-thread execution state for processing through this pipeline. The actual value is a java.lang.Integer object containing the subscript into the values array, or a subscript equal to values.length if the basic Valve is currently being processed.

Constructor Detail

JetspeedPipeline

public JetspeedPipeline(String name,
                        List valveList)
                 throws Exception

Constructor that provides the descriptor for building the pipeline

Method Detail

initialize

public void initialize()
                throws PipelineException

Specified by:

initialize in interface Pipeline

Throws:

PipelineException

See Also:

org.apache.plexus.summit.Pipeline#init()

setName

public void setName(String name)

Set the name of this pipeline.

Parameters:

name - Name of this pipeline.

getName

public String getName()

Get the name of this pipeline.

Returns:

String Name of this pipeline.

addValve

public void addValve(Valve valve)

Description copied from interface: Pipeline

Add a new Valve to the end of the pipeline.

Specified by:

addValve in interface Pipeline

Parameters:

valve - Valve to be added.

See Also:

org.apache.plexus.summit.Pipeline#addValve(Valve)

getValves

public Valve[] getValves()

Description copied from interface: Pipeline

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

Specified by:

getValves in interface Pipeline

Returns:

An array of valves.

See Also:

org.apache.plexus.summit.Pipeline#getValves()

removeValve

public void removeValve(Valve valve)

Description copied from interface: Pipeline

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

Specified by:

removeValve in interface Pipeline

Parameters:

valve - Valve to be removed.

See Also:

org.apache.plexus.summit.Pipeline#removeValve(Valve)

invoke

public void invoke(org.apache.jetspeed.request.RequestContext request)
            throws PipelineException

Description copied from interface: Pipeline

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.

Specified by:

invoke in interface Pipeline

Throws:

PipelineException

See Also:

org.apache.plexus.summit.Pipeline#invoke(RequestContext)

invokeNext

public void invokeNext(org.apache.jetspeed.request.RequestContext request)
                throws PipelineException

Description copied from interface: ValveContext

Cause the invoke() method of the next Valve that is part of the Pipeline currently being processed (if any) to be executed, passing on the specified request and response objects plus this ValveContext instance. Exceptions thrown by a subsequently executed Valve will be passed on to our caller.

If there are no more Valves to be executed, execution of this method will result in a no op.

Specified by:

invokeNext in interface ValveContext

Throws:

PipelineException

See Also:

org.apache.plexus.summit.ValveContext#invokeNext(RequestContext)