public interface Pipeline
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.
| Modifier and Type | Method and Description | 
|---|---|
| void | addValve(Valve valve)Add a new Valve to the end of the pipeline associated with this
 Container. | 
| Valve | getBasic() | 
| Container | getContainer() | 
| Valve | getFirst() | 
| Valve[] | getValves() | 
| boolean | isAsyncSupported()Returns true if all the valves in this pipeline support async, false otherwise | 
| void | removeValve(Valve valve)Remove the specified Valve from the pipeline associated with this
 Container, if it is found; otherwise, do nothing. | 
| void | setBasic(Valve valve)Set the Valve instance that has been distinguished as the basic
 Valve for this Pipeline (if any). | 
| void | setContainer(Container container)Set the Container with which this Pipeline is associated. | 
Valve getBasic()
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.
valve - Valve to be distinguished as the basic Valvevoid 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.
valve - Valve to be addedIllegalArgumentException - if this Container refused to
  accept the specified ValveIllegalArgumentException - if the specified Valve refuses to be
  associated with this ContainerIllegalStateException - if the specified Valve is already
  associated with a different ContainerValve[] getValves()
void removeValve(Valve valve)
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.
valve - Valve to be removedValve getFirst()
boolean isAsyncSupported()
Container getContainer()
void setContainer(Container container)
container - The new associated containerCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.