org.jahia.pipelines.impl

Class GenericPipeline

java.lang.Object

org.jahia.pipelines.impl.GenericPipeline

All Implemented Interfaces:

Pipeline, ValveContext

public class GenericPipeline
extends Object
implements Pipeline, ValveContext

Flexible implementation of a Pipeline.

Version:

$Id$

Author:

Jason van Zyl, David Sean Taylor

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	environment
protected String	name Name of this pipeline.
protected ThreadLocal<Integer>	state The per-thread execution state for processing through this pipeline.

Constructor Summary

Constructors

Constructor and Description
GenericPipeline()

Method Summary

Modifier and Type	Method and Description
void	addValve(int position, Valve valve)
void	addValve(Valve valve) Add a new Valve to the end of the pipeline.
Map<String,Object>	getEnvironment() Retrieve the environment of the pipeline, this is usually useful inside valve implementation to retrieve the environment of the pipeline, and for example access service instance, etc...
Valve	getFirstValveOfClass(Class<Valve> c) Return the first valve of the pipeline that is an instance of a given class or interface.
String	getName() Get the name of this pipeline.
Valve[]	getValves() Return the set of all Valves in the pipeline.
boolean	hasValveOfClass(Class<Valve> c) Tell if (at least) one of the valves of the pipeline is an instance of a given class or interface.
int	indexOf(Valve valve)
void	initialize()
void	invoke(Object 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	invokeNext(Object context) 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	setEnvironment(Map<String,Object> environment) Used by users of the pipeline to provide an environment in which the valves will execute.
void	setName(String name) Set the name of this pipeline.
void	setValves(Valve[] valves)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Name of this pipeline.

state

protected ThreadLocal<Integer> 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.

environment

protected Map<String,Object> environment

Constructor Detail

GenericPipeline

public GenericPipeline()

Method Detail

getEnvironment

public Map<String,Object> getEnvironment()

Description copied from interface: ValveContext

Retrieve the environment of the pipeline, this is usually useful inside valve implementation to retrieve the environment of the pipeline, and for example access service instance, etc...

Specified by:

getEnvironment in interface ValveContext

Returns:

setEnvironment

public void setEnvironment(Map<String,Object> environment)

Description copied from interface: Pipeline

Used by users of the pipeline to provide an environment in which the valves will execute. This can be useful for example to provide service references, or other shared data among all the valves.

Specified by:

setEnvironment in interface Pipeline

initialize

public void initialize()
                throws PipelineException

Specified by:

initialize in interface Pipeline

Throws:

PipelineException

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.

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.

setValves

public void setValves(Valve[] valves)

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.

addValve

public void addValve(int position,
                     Valve valve)

Since:

Jahia 6.6.0.0

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.

invoke

public void invoke(Object context)
            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

Parameters:

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

Throws:

PipelineException - an input/output error occurred.

invokeNext

public void invokeNext(Object context)
                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

Parameters:

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

Throws:

PipelineException - Thrown by a subsequent Valve.

hasValveOfClass

public boolean hasValveOfClass(Class<Valve> c)

Description copied from interface: Pipeline

Tell if (at least) one of the valves of the pipeline is an instance of a given class or interface.

Specified by:

hasValveOfClass in interface Pipeline

Parameters:

c - the class or interface

Returns:

See Also:

Pipeline.hasValveOfClass(java.lang.Class)

getFirstValveOfClass

public Valve getFirstValveOfClass(Class<Valve> c)

Description copied from interface: Pipeline

Return the first valve of the pipeline that is an instance of a given class or interface.

Specified by:

getFirstValveOfClass in interface Pipeline

Parameters:

c - the class or interface

Returns:

a Valve instance, or null if no valve matches.

See Also:

Pipeline.getFirstValveOfClass(java.lang.Class)

indexOf

public int indexOf(Valve valve)

Since:

Jahia 6.6.0.0