org.apache.catalina.core
public class StandardPipeline extends java.lang.Object implements Pipeline, Contained, Lifecycle
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.Modifier and Type | Field and Description |
---|---|
protected Valve |
basic
The basic Valve (if any) associated with this Pipeline.
|
protected Container |
container
The Container with which this Pipeline is associated.
|
protected Valve |
first
The first valve associated with this Pipeline.
|
protected java.lang.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?
|
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
StandardPipeline()
Construct a new StandardPipeline instance with no associated Container.
|
StandardPipeline(Container container)
Construct a new StandardPipeline instance that is associated with the
specified Container.
|
Modifier and Type | Method and Description |
---|---|
void |
addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
|
void |
addValve(Valve valve)
Add a new Valve to the end of the pipeline associated with this
Container.
|
LifecycleListener[] |
findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
|
Valve |
getBasic()
Return the Valve instance that has been distinguished as the basic
Valve for this Pipeline (if any).
|
Container |
getContainer()
Return the Container with which this Pipeline is associated.
|
Valve |
getFirst()
Return the Valve instance that has been distinguished as the basic
Valve for this Pipeline (if any).
|
java.lang.String |
getInfo()
Return descriptive information about this implementation class.
|
javax.management.ObjectName[] |
getValveObjectNames() |
Valve[] |
getValves()
Return the set of Valves in the pipeline associated with this
Container, including the basic Valve (if any).
|
void |
removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
|
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.
|
void |
start()
Prepare for active use of the public methods of this Component.
|
void |
stop()
Gracefully shut down active use of the public methods of this Component.
|
protected Valve basic
protected Container container
protected java.lang.String info
protected LifecycleSupport lifecycle
protected static StringManager sm
protected boolean started
protected Valve first
public StandardPipeline()
public StandardPipeline(Container container)
container
- The container we should be associated withpublic java.lang.String getInfo()
public Container getContainer()
getContainer
in interface Contained
public void setContainer(Container container)
setContainer
in interface Contained
container
- The new associated containerpublic void addLifecycleListener(LifecycleListener listener)
addLifecycleListener
in interface Lifecycle
listener
- The listener to addpublic LifecycleListener[] findLifecycleListeners()
findLifecycleListeners
in interface Lifecycle
public void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener
in interface Lifecycle
listener
- The listener to removepublic void start() throws LifecycleException
start
in interface Lifecycle
LifecycleException
- if this component detects a fatal error
that prevents it from being startedpublic void stop() throws LifecycleException
stop
in interface Lifecycle
LifecycleException
- if this component detects a fatal error
that needs to be reportedpublic Valve getBasic()
Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).
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 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.
addValve
in interface Pipeline
valve
- Valve to be addedjava.lang.IllegalArgumentException
- if this Container refused to
accept the specified Valvejava.lang.IllegalArgumentException
- if the specifie Valve refuses to be
associated with this Containerjava.lang.IllegalStateException
- if the specified Valve is already
associated with a different Containerpublic Valve[] getValves()
public javax.management.ObjectName[] getValveObjectNames()
public void removeValve(Valve valve)
setContainer(null)
method
will be called if it implements Contained
.removeValve
in interface Pipeline
valve
- Valve to be removedCopyright © 2000-2014 Apache Software Foundation. All Rights Reserved.