Tomcat 10.1.19 · org.apache.catalina.Pipeline · APIdia, the JavaDoc alternative

Interface describing a collection of Valves that should be executed in sequence when the invoke() method is invoked. It is required that a Valve somewhere in the pipeline (usually the last one) must process the request and create the corresponding response, rather than trying to pass the request on.

There is generally a single Pipeline instance associated with each Container. The container's normal request processing functionality is generally encapsulated in a container-specific Valve, which should always be executed at the end of a pipeline. To facilitate this, the setBasic() method is provided to set the Valve instance that will always be executed last. Other Valves will be executed in the order that they were added, before the basic Valve is executed.

Method Summary

Modifier and Type	Method and Description
public void	addValve(Valve Valve to be added valve) Add a new Valve to the end of the pipeline associated with this Container.
public void	findNonAsyncValves(Set<String> The Set to which the fully qualified class names of each Valve in this Pipeline that does not support async will be added result) Identifies the Valves, if any, in this Pipeline that do not support async.
public Valve	Returns: the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). getBasic()
public Valve	Returns: the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). getFirst()
public Valve[]	Returns: the set of Valves in the pipeline associated with this Container, including the basic Valve (if any). If there are no such Valves, a zero-length array is returned. getValves()
public boolean	Returns: true if all the valves in this pipeline support async, false otherwise isAsyncSupported() Returns true if all the valves in this pipeline support async, false otherwise
public void	removeValve(Valve Valve to be removed valve) Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do nothing.
public void	setBasic(Valve Valve to be distinguished as the basic Valve valve) Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

Inherited from org.apache.catalina.Contained:: getContainer setContainer

Method Detail

addValve back to summary

addValve	back to summary
public void addValve(Valve valve) Add a new Valve to the end of the pipeline associated with this Container. Prior to adding the Valve, the Valve's `setContainer()` method will be called, if it implements `Contained`, with the owning Container as an argument. The method may throw an `IllegalArgumentException` if this Valve chooses not to be associated with this Container, or `IllegalStateException` if it is already associated with a different Container. Implementation Note Implementations are expected to trigger the `Container#ADD_VALVE_EVENT` for the associated container if this call is successful. Parameters valve:Valve Valve to be added Exceptions IllegalArgumentException: if this Container refused to accept the specified Valve if the specified Valve refuses to be associated with this Container IllegalStateException: if the specified Valve is already associated with a different Container

public void addValve(Valve valve)

Add a new Valve to the end of the pipeline associated with this Container. Prior to adding the Valve, the Valve's setContainer() method will be called, if it implements Contained, with the owning Container as an argument. The method may throw an IllegalArgumentException if this Valve chooses not to be associated with this Container, or IllegalStateException if it is already associated with a different Container.

Implementation Note

Implementations are expected to trigger the Container#ADD_VALVE_EVENT for the associated container if this call is successful.

Parameters

valve:Valve: Valve to be added

Exceptions

IllegalArgumentException:

if this Container refused to accept the specified Valve
if the specified Valve refuses to be associated with this Container

IllegalStateException:

if the specified Valve is already associated with a different Container

findNonAsyncValves	back to summary
public void findNonAsyncValves(Set<String> result) Identifies the Valves, if any, in this Pipeline that do not support async. Parameters result:Set<String> The Set to which the fully qualified class names of each Valve in this Pipeline that does not support async will be added

findNonAsyncValves

back to summary

public void findNonAsyncValves(Set<String> result)

Identifies the Valves, if any, in this Pipeline that do not support async.

Parameters

result:Set<String>: The Set to which the fully qualified class names of each Valve in this Pipeline that does not support async will be added

getBasic	back to summary
public Valve getBasic() Returns:Valve the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

getFirst	back to summary
public Valve getFirst() Returns:Valve the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

getValves	back to summary
public Valve[] getValves() Returns:Valve[] the set of Valves in the pipeline associated with this Container, including the basic Valve (if any). If there are no such Valves, a zero-length array is returned.

isAsyncSupported	back to summary
public boolean isAsyncSupported() Returns true if all the valves in this pipeline support async, false otherwise Returns:boolean true if all the valves in this pipeline support async, false otherwise

isAsyncSupported

back to summary

public boolean isAsyncSupported()

Returns true if all the valves in this pipeline support async, false otherwise

Returns:boolean: true if all the valves in this pipeline support async, false otherwise

removeValve back to summary

removeValve	back to summary
public void removeValve(Valve valve) Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do nothing. If the Valve is found and removed, the Valve's `setContainer(null)` method will be called if it implements `Contained`. Implementation Note Implementations are expected to trigger the `Container#REMOVE_VALVE_EVENT` for the associated container if this call is successful. Parameters valve:Valve Valve to be removed

public void removeValve(Valve valve)

Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do nothing. If the Valve is found and removed, the Valve's setContainer(null) method will be called if it implements Contained.

Implementation Note

Implementations are expected to trigger the Container#REMOVE_VALVE_EVENT for the associated container if this call is successful.

Parameters

valve:Valve: Valve to be removed

setBasic back to summary

setBasic	back to summary
public void setBasic(Valve valve) Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). Prior to setting the basic Valve, the Valve's `setContainer()` will be called, if it implements `Contained`, with the owning Container as an argument. The method may throw an `IllegalArgumentException` if this Valve chooses not to be associated with this Container, or `IllegalStateException` if it is already associated with a different Container. Parameters valve:Valve Valve to be distinguished as the basic Valve

public void setBasic(Valve valve)

Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). Prior to setting the basic Valve, the Valve's setContainer() will be called, if it implements Contained, with the owning Container as an argument. The method may throw an IllegalArgumentException if this Valve chooses not to be associated with this Container, or IllegalStateException if it is already associated with a different Container.

Parameters

valve:Valve: Valve to be distinguished as the basic Valve

public Interface Pipeline

Method Summary

Method Detail