Save This Page
Home » apache-tomcat-6.0.26-src » org.apache » catalina » core » [javadoc | source]
org.apache.catalina.core
public class: StandardPipeline [javadoc | source]
java.lang.Object
   org.apache.catalina.core.StandardPipeline

All Implemented Interfaces:
    Pipeline, Lifecycle, Contained

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.
Field Summary
protected  Valve basic    The basic Valve (if any) associated with this Pipeline. 
protected  Container container    The Container with which this Pipeline is associated. 
protected  String info    Descriptive information about this implementation. 
protected  LifecycleSupport lifecycle    The lifecycle event support for this component. 
protected static  StringManager sm    The string manager for this package. 
protected  boolean started    Has this component been started yet? 
protected  Valve first    The first valve associated with this Pipeline. 
Constructor:
 public 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 from org.apache.catalina.core.StandardPipeline Summary:
addLifecycleListener,   addValve,   findLifecycleListeners,   getBasic,   getContainer,   getFirst,   getInfo,   getValveObjectNames,   getValves,   removeLifecycleListener,   removeValve,   setBasic,   setContainer,   start,   stop
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.catalina.core.StandardPipeline Detail:
 public  void addLifecycleListener(LifecycleListener listener) 
    Add a lifecycle event listener to this component.
 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.

 public LifecycleListener[] findLifecycleListeners() 
    Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
 public Valve getBasic() 

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

 public Container getContainer() 
    Return the Container with which this Pipeline is associated.
 public Valve getFirst() 
 public String getInfo() 
    Return descriptive information about this implementation class.
 public ObjectName[] getValveObjectNames() 
 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.
 public  void removeLifecycleListener(LifecycleListener listener) 
    Remove a lifecycle event listener from this component.
 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.
 public  void setBasic(Valve valve) 

    Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). Prioer 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.

 public  void setContainer(Container container) 
    Set the Container with which this Pipeline is associated.
 public synchronized  void start() throws LifecycleException 
    Prepare for active use of the public methods of this Component.
 public synchronized  void stop() throws LifecycleException 
    Gracefully shut down active use of the public methods of this Component.