|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.catalina.core.ContainerBase
Abstract implementation of the Container interface, providing common
functionality required by nearly every implementation. Classes extending
this base class must implement getInfo()
, and may implement
a replacement for invoke()
.
All subclasses of this abstract base class will include support for a
Pipeline object that defines the processing to be performed for each request
received by the invoke()
method of this class, utilizig the
"Chain of Responsibility" design pattern. A subclass should encapsulate its
own processing functionality as a Valve
, and configure this
Valve into the pipeline by calling setBasic()
.
This implementation fires property change events, per the JavaBeans design
pattern, for changes in singleton properties. In addition, it fires the
following ContainerEvent
events to listeners who register
themselves with addContainerListener()
:
Type | Data | Description |
---|---|---|
addChild |
Container |
Child container added to this Container. |
addValve |
Valve |
Valve added to this Container. |
removeChild |
Container |
Child container removed from this Container. |
removeValve |
Valve |
Valve removed from this Container. |
start |
null |
Container was started. |
stop |
null |
Container was stopped. |
Field Summary | |
protected java.util.HashMap |
children
The child Containers belonging to this Container, keyed by name. |
protected Cluster |
cluster
The cluster with which this Container is associated. |
protected int |
debug
The debugging detail level for this component. |
protected LifecycleSupport |
lifecycle
The lifecycle event support for this component. |
protected java.util.ArrayList |
listeners
The container event listeners for this Container. |
protected Loader |
loader
The Loader implementation with which this Container is associated. |
protected Logger |
logger
The Logger implementation with which this Container is associated. |
protected Manager |
manager
The Manager implementation with which this Container is associated. |
protected Mapper |
mapper
The one and only Mapper associated with this Container, if any. |
protected java.lang.String |
mapperClass
The Java class name of the default Mapper class for this Container. |
protected java.util.HashMap |
mappers
The set of Mappers associated with this Container, keyed by protocol. |
protected java.lang.String |
name
The human-readable name of this Container. |
protected Container |
parent
The parent Container to which this Container is a child. |
protected java.lang.ClassLoader |
parentClassLoader
The parent class loader to be configured when we install a Loader. |
protected Pipeline |
pipeline
The Pipeline object with which this Container is associated. |
protected Realm |
realm
The Realm with which this Container is associated. |
protected javax.naming.directory.DirContext |
resources
The resources DirContext object with which this Container is associated. |
protected static StringManager |
sm
The string manager for this package. |
protected boolean |
started
Has this component been started? |
protected java.beans.PropertyChangeSupport |
support
The property change support for this component. |
Fields inherited from interface org.apache.catalina.Container |
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT |
Fields inherited from interface org.apache.catalina.Lifecycle |
START_EVENT, STOP_EVENT |
Constructor Summary | |
ContainerBase()
|
Method Summary | |
void |
addChild(Container child)
Add a new child Container to those associated with this Container, if supported. |
void |
addContainerListener(ContainerListener listener)
Add a container event listener to this component. |
protected void |
addDefaultMapper(java.lang.String mapperClass)
Add a default Mapper implementation if none have been configured explicitly. |
void |
addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component. |
void |
addMapper(Mapper mapper)
Add the specified Mapper associated with this Container. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component. |
void |
addValve(Valve valve)
Add a new Valve to the end of the pipeline associated with this Container. |
Container |
findChild(java.lang.String name)
Return the child Container, associated with this Container, with the specified name (if any); otherwise, return null |
Container[] |
findChildren()
Return the set of children Containers associated with this Container. |
Mapper |
findMapper(java.lang.String protocol)
Return the Mapper associated with the specified protocol, if there is one. |
Mapper[] |
findMappers()
Return the set of Mappers associated with this Container. |
void |
fireContainerEvent(java.lang.String type,
java.lang.Object data)
Notify all container event listeners that a particular event has occurred for this Container. |
Valve |
getBasic()
Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). |
Cluster |
getCluster()
Return the Cluster with which this Container is associated. |
int |
getDebug()
Return the debugging detail level for this component. |
abstract java.lang.String |
getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version> . |
Loader |
getLoader()
Return the Loader with which this Container is associated. |
Logger |
getLogger()
Return the Logger with which this Container is associated. |
Manager |
getManager()
Return the Manager with which this Container is associated. |
java.lang.String |
getName()
Return a name string (suitable for use by humans) that describes this Container. |
Container |
getParent()
Return the Container for which this Container is a child, if there is one. |
java.lang.ClassLoader |
getParentClassLoader()
Return the parent class loader (if any) for this web application. |
Pipeline |
getPipeline()
Return the Pipeline object that manages the Valves associated with this Container. |
Realm |
getRealm()
Return the Realm with which this Container is associated. |
javax.naming.directory.DirContext |
getResources()
Return the resources DirContext object with which this Container is associated. |
Valve[] |
getValves()
Return the set of Valves in the pipeline associated with this Container, including the basic Valve (if any). |
void |
invoke(Request request,
Response response)
Process the specified Request, to produce the corresponding Response, by invoking the first Valve in our pipeline (if any), or the basic Valve otherwise. |
protected void |
log(java.lang.String message)
Log the specified message to our current Logger (if any). |
protected void |
log(java.lang.String message,
java.lang.Throwable throwable)
Log the specified message and exception to our current Logger (if any). |
protected java.lang.String |
logName()
Return the abbreviated name of this container for logging messsages |
Container |
map(Request request,
boolean update)
Return the child Container that should be used to process this Request, based upon its characteristics. |
void |
removeChild(Container child)
Remove an existing child Container from association with this parent Container. |
void |
removeContainerListener(ContainerListener listener)
Remove a container event listener from this component. |
void |
removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component. |
void |
removeMapper(Mapper mapper)
Remove a Mapper associated with this Container, if any. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change 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 |
setCluster(Cluster cluster)
Set the Cluster with which this Container is associated. |
void |
setDebug(int debug)
Set the debugging detail level for this component. |
void |
setLoader(Loader loader)
Set the Loader with which this Container is associated. |
void |
setLogger(Logger logger)
Set the Logger with which this Container is associated. |
void |
setManager(Manager manager)
Set the Manager with which this Container is associated. |
void |
setName(java.lang.String name)
Set a name string (suitable for use by humans) that describes this Container. |
void |
setParent(Container container)
Set the parent Container to which this Container is being added as a child. |
void |
setParentClassLoader(java.lang.ClassLoader parent)
Set the parent class loader (if any) for this web application. |
void |
setRealm(Realm realm)
Set the Realm with which this Container is associated. |
void |
setResources(javax.naming.directory.DirContext resources)
Set the resources DirContext object with which this Container 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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.HashMap children
protected int debug
protected LifecycleSupport lifecycle
protected java.util.ArrayList listeners
protected Loader loader
protected Logger logger
protected Manager manager
protected Cluster cluster
protected Mapper mapper
protected java.util.HashMap mappers
protected java.lang.String mapperClass
protected java.lang.String name
protected Container parent
protected java.lang.ClassLoader parentClassLoader
protected Pipeline pipeline
protected Realm realm
protected javax.naming.directory.DirContext resources
protected static StringManager sm
protected boolean started
protected java.beans.PropertyChangeSupport support
Constructor Detail |
public ContainerBase()
Method Detail |
public int getDebug()
public void setDebug(int debug)
debug
- The new debugging detail levelpublic abstract java.lang.String getInfo()
<description>/<version>
.
getInfo
in interface Container
public Loader getLoader()
null
.
getLoader
in interface Container
public void setLoader(Loader loader)
setLoader
in interface Container
loader
- The newly associated loaderpublic Logger getLogger()
null
.
getLogger
in interface Container
public void setLogger(Logger logger)
setLogger
in interface Container
logger
- The newly associated Loggerpublic Manager getManager()
null
.
getManager
in interface Container
public void setManager(Manager manager)
setManager
in interface Container
manager
- The newly associated Managerpublic Cluster getCluster()
null
.
getCluster
in interface Container
public void setCluster(Cluster cluster)
setCluster
in interface Container
public java.lang.String getName()
getName
in interface Container
public void setName(java.lang.String name)
setName
in interface Container
name
- New name of this container
java.lang.IllegalStateException
- if this Container has already been
added to the children of a parent Container (after which the name
may not be changed)public Container getParent()
null
.
getParent
in interface Container
public void setParent(Container container)
setParent
in interface Container
container
- Container to which this Container is being added
as a child
java.lang.IllegalArgumentException
- if this Container refuses to become
attached to the specified Containerpublic java.lang.ClassLoader getParentClassLoader()
getParentClassLoader
in interface Container
public void setParentClassLoader(java.lang.ClassLoader parent)
setParentClassLoader
in interface Container
parent
- The new parent class loaderpublic Pipeline getPipeline()
public Realm getRealm()
null
.
getRealm
in interface Container
public void setRealm(Realm realm)
setRealm
in interface Container
realm
- The newly associated Realmpublic javax.naming.directory.DirContext getResources()
null
.
getResources
in interface Container
public void setResources(javax.naming.directory.DirContext resources)
setResources
in interface Container
resources
- The newly associated DirContextpublic void addChild(Container child)
setParent()
method must be called, with this
Container as an argument. This method may thrown an
IllegalArgumentException
if this Container chooses not
to be attached to the specified Container, in which case it is not added
addChild
in interface Container
child
- New child Container to be added
java.lang.IllegalArgumentException
- if this exception is thrown by
the setParent()
method of the child Container
java.lang.IllegalArgumentException
- if the new child does not have
a name unique from that of existing children of this Container
java.lang.IllegalStateException
- if this Container does not support
child Containerspublic void addContainerListener(ContainerListener listener)
addContainerListener
in interface Container
listener
- The listener to addpublic void addMapper(Mapper mapper)
addMapper
in interface Container
mapper
- The corresponding Mapper implementation
java.lang.IllegalArgumentException
- if this exception is thrown by
the setContainer()
method of the Mapperpublic void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
addPropertyChangeListener
in interface Container
listener
- The listener to addpublic Container findChild(java.lang.String name)
null
findChild
in interface Container
name
- Name of the child Container to be retrievedpublic Container[] findChildren()
findChildren
in interface Container
public Mapper findMapper(java.lang.String protocol)
null
.
findMapper
in interface Container
protocol
- Protocol for which to find a Mapperpublic Mapper[] findMappers()
findMappers
in interface Container
public void invoke(Request request, Response response) throws java.io.IOException, javax.servlet.ServletException
invoke
in interface Container
request
- Request to be processedresponse
- Response to be produced
java.lang.IllegalStateException
- if neither a pipeline or a basic
Valve have been configured for this Container
java.io.IOException
- if an input/output error occurred while
processing
javax.servlet.ServletException
- if a ServletException was thrown
while processing this requestpublic Container map(Request request, boolean update)
null
instead.
map
in interface Container
request
- Request being processedupdate
- Update the Request to reflect the mapping selection?public void removeChild(Container child)
removeChild
in interface Container
child
- Existing child Container to be removedpublic void removeContainerListener(ContainerListener listener)
removeContainerListener
in interface Container
listener
- The listener to removepublic void removeMapper(Mapper mapper)
removeMapper
in interface Container
mapper
- The Mapper to be removedpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
removePropertyChangeListener
in interface Container
listener
- The listener to removepublic void addLifecycleListener(LifecycleListener listener)
addLifecycleListener
in interface Lifecycle
listener
- The listener to addpublic void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener
in interface Lifecycle
listener
- The listener to removepublic void start() throws LifecycleException
start
in interface Lifecycle
java.lang.IllegalStateException
- if this component has already been
started
LifecycleException
- if this component detects a fatal error
that prevents it from being startedpublic void stop() throws LifecycleException
stop
in interface Lifecycle
java.lang.IllegalStateException
- if this component has not been started
LifecycleException
- if this component detects a fatal error
that needs to be reportedpublic void addValve(Valve valve)
setContainer
method must be called, with this 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 added
java.lang.IllegalArgumentException
- if this Container refused to
accept the specified Valve
java.lang.IllegalArgumentException
- if the specifie Valve refuses to be
associated with this Container
java.lang.IllegalStateException
- if the specified Valve is already
associated with a different Containerpublic Valve getBasic()
Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).
getBasic
in interface Pipeline
public Valve[] getValves()
getValves
in interface Pipeline
public void removeValve(Valve valve)
removeValve
in interface Pipeline
valve
- Valve to be removedpublic 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.
setBasic
in interface Pipeline
valve
- Valve to be distinguished as the basic Valveprotected void addDefaultMapper(java.lang.String mapperClass)
mapperClass
- Java class name of the default Mapperpublic void fireContainerEvent(java.lang.String type, java.lang.Object data)
type
- Event typedata
- Event dataprotected void log(java.lang.String message)
message
- Message to be loggedprotected void log(java.lang.String message, java.lang.Throwable throwable)
message
- Message to be loggedthrowable
- Related exceptionprotected java.lang.String logName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |