Package org.apache.catalina.core

Class StandardPipeline

  • All Implemented Interfaces:
    Contained, Lifecycle, Pipeline
    public class StandardPipeline
extends LifecycleBase
implements Pipeline
    Standard implementation of a processing Pipeline that will invoke a series of Valves that have been configured to be called in order. This implementation can be used for any type of Container. IMPLEMENTATION WARNING - This implementation assumes that no calls to addValve() or removeValve are allowed while a request is currently being processed. Otherwise, the mechanism by which per-thread state is maintained will need to be modified.
    Author:
    Craig R. McClanahan

    • Field Detail

      • basic

        protected Valve basic
        The basic Valve (if any) associated with this Pipeline.

      • container

        protected Container container
        The Container with which this Pipeline is associated.

      • first

        protected Valve first
        The first valve associated with this Pipeline.

    • Constructor Detail

      • StandardPipeline

        public StandardPipeline()
        Construct a new StandardPipeline instance with no associated Container.

      • StandardPipeline

        public StandardPipeline​(Container container)
        Construct a new StandardPipeline instance that is associated with the specified Container.
        Parameters:
        container - The container we should be associated with

    • Method Detail

      • isAsyncSupported

        public boolean isAsyncSupported()
        Description copied from interface: Pipeline
        Returns true if all the valves in this pipeline support async, false otherwise
        Specified by:
        isAsyncSupported in interface Pipeline
        Returns:
        true if all the valves in this pipeline support async, false otherwise

      • findNonAsyncValves

        public void findNonAsyncValves​(java.util.Set<java.lang.String> result)
        Description copied from interface: Pipeline
        Identifies the Valves, if any, in this Pipeline that do not support async.
        Specified by:
        findNonAsyncValves in interface Pipeline
        Parameters:
        result - The Set to which the fully qualified class names of each Valve in this Pipeline that does not support async will be added

      • getContainer

        public Container getContainer()
        Return the Container with which this Pipeline is associated.
        Specified by:
        getContainer in interface Contained
        Returns:
        The Container with which this instance is associated or null if not associated with a Container

      • setContainer

        public void setContainer​(Container container)
        Set the Container with which this Pipeline is associated.
        Specified by:
        setContainer in interface Contained
        Parameters:
        container - The new associated container

      • initInternal

        protected void initInternal()
        Description copied from class: LifecycleBase
        Sub-classes implement this method to perform any instance initialisation required.
        Specified by:
        initInternal in class LifecycleBase

      • destroyInternal

        protected void destroyInternal()
        Description copied from class: LifecycleBase
        Sub-classes implement this method to perform any instance destruction required.
        Specified by:
        destroyInternal in class LifecycleBase

      • toString

        public java.lang.String toString()
        Return a String representation of this component.
        Overrides:
        toString in class java.lang.Object

      • getBasic

        public Valve getBasic()

        Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

        Specified by:
        getBasic in interface Pipeline
        Returns:
        the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

      • setBasic

        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.

        Specified by:
        setBasic in interface Pipeline
        Parameters:
        valve - Valve to be distinguished as the basic Valve

      • addValve

        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.

        Specified by:
        addValve in interface Pipeline
        Parameters:
        valve - Valve to be added
        Throws:
        java.lang.IllegalArgumentException - if this Container refused to accept the specified Valve
        java.lang.IllegalArgumentException - if the specified Valve refuses to be associated with this Container
        java.lang.IllegalStateException - if the specified Valve is already associated with a different Container

      • getValves

        public Valve[] getValves()
        Return 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.
        Specified by:
        getValves in interface Pipeline
        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.

      • getValveObjectNames

        public javax.management.ObjectName[] getValveObjectNames()

      • removeValve

        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.
        Specified by:
        removeValve in interface Pipeline
        Parameters:
        valve - Valve to be removed

      • getFirst

        public Valve getFirst()
        Specified by:
        getFirst in interface Pipeline
        Returns:
        the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).