Package org.apache.catalina.core
Class ContainerBase
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.core.ContainerBase
- All Implemented Interfaces:
- MBeanRegistration,- Container,- JmxEnabled,- Lifecycle
- Direct Known Subclasses:
- StandardContext,- StandardEngine,- StandardHost,- StandardWrapper
Abstract implementation of the Container interface, providing common functionality required by nearly every
 implementation. Classes extending this base class must may implement a replacement for 
 
 Subclasses that fire additional events should document them in the class comments of the implementation class.
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, utilizing 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. | 
|  | Valve | Valve added to this Container. | 
| removeChild | Container | Child container removed from this Container. | 
|  | Valve | Valve removed from this Container. | 
| start | null | Container was started. | 
| stop | null | Container was stopped. | 
- Author:
- Craig R. McClanahan
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classPrivate runnable class to invoke the backgroundProcess method of this container and its children after a fixed delay.protected classprotected classPerform addChild with the permissions of this class. addChild can be called with the XML parser on the stack, this allows the XML parser to have fewer privileges than Tomcat.Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected AccessLogThe access log to use for requests normally handled by this container that have been handled earlier in the processing chain.protected intThe processor delay for this component.protected ScheduledFuture<?>The future allowing control of the background processor.The child Containers belonging to this Container, keyed by name.protected ClusterThe cluster with which this Container is associated.protected final List<ContainerListener>The container event listeners for this Container.protected LogThe Logger implementation with which this Container is associated.protected StringAssociated logger name.protected ScheduledFuture<?>protected StringThe human-readable name of this Container.protected ContainerThe parent Container to which this Container is a child.protected ClassLoaderThe parent class loader to be configured when we install a Loader.protected final PipelineThe Pipeline object with which this Container is associated.protected static final StringManagerThe string manager for this package.protected booleanWill children be started automatically when they are added.protected ExecutorServiceprotected final PropertyChangeSupportThe property change support for this component.Fields inherited from interface org.apache.catalina.ContainerADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTFields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a new child Container to those associated with this Container, if supported.voidaddContainerListener(ContainerListener listener) Add a container event listener to this component.voidAdd a property change listener to this component.voidConvenience method, intended for use by the digester to simplify the process of adding Valves to containers.voidExecute a periodic task, such as reloading, etc.protected voidSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.Return the child Container, associated with this Container, with the specified name (if any); otherwise, returnnullReturn the set of children Containers associated with this Container.Return the set of container listeners associated with this Container.voidfireContainerEvent(String type, Object data) Notify all container event listeners that a particular event has occurred for this Container.Obtain the AccessLog to use to log a request/response that is destined for this container.intGet the delay between the invocation of the backgroundProcess method on this container and its children.Obtain the location of CATALINA_BASE.Obtain the location of CATALINA_HOME.Return the Cluster with which this Container is associated.protected Clusterprotected StringMethod implemented by sub-classes to identify the domain in which MBeans should be registered.Return the Logger for this Container.Return the logger name that the container will use.Calculate the key properties string to be added to an object'sObjectNameto indicate that it is associated with this container.getName()Return a name string (suitable for use by humans) that describes this Container.Return the Container for which this Container is a child, if there is one.Return the parent class loader (if any) for this web application.Return the Pipeline object that manages the Valves associated with this Container.getRealm()Return the Realm with which this Container is associated.protected RealmbooleanReturn if children of this container will be started automatically when they are added to this container.intObtain the number of threads available for starting and stopping any children associated with this container.voidCheck this container for an access log and if none is found, look to the parent.voidremoveChild(Container child) Remove an existing child Container from association with this parent Container.voidremoveContainerListener(ContainerListener listener) Remove a container event listener from this component.voidRemove a property change listener from this component.voidsetBackgroundProcessorDelay(int delay) Set the delay between the invocation of the execute method on this container and its children.voidsetCluster(Cluster cluster) Set the Cluster with which this Container is associated.voidSet a name string (suitable for use by humans) that describes this Container.voidSet the parent Container to which this Container is being added as a child.voidsetParentClassLoader(ClassLoader parent) Set the parent class loader (if any) for this web application.voidSet the Realm with which this Container is associated.voidsetStartChildren(boolean startChildren) Set if children of this container will be started automatically when they are added to this container.voidsetStartStopThreads(int startStopThreads) Sets the number of threads available for starting and stopping any children associated with this container.protected voidStart this component and implement the requirements ofLifecycleBase.startInternal().protected voidStop this component and implement the requirements ofLifecycleBase.stopInternal().protected voidStart the background thread that will periodically check for session timeouts.protected voidStop the background thread that is periodically checking for session timeouts.final StringtoString()Methods inherited from class org.apache.catalina.util.LifecycleMBeanBasegetDomain, getObjectName, getObjectNameKeyProperties, initInternal, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.catalina.ContainergetDomain, getObjectNameMethods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
- 
Field Details- 
childrenThe child Containers belonging to this Container, keyed by name.
- 
backgroundProcessorDelayprotected int backgroundProcessorDelayThe processor delay for this component.
- 
backgroundProcessorFutureThe future allowing control of the background processor.
- 
monitorFuture
- 
listenersThe container event listeners for this Container. Implemented as a CopyOnWriteArrayList since listeners may invoke methods to add/remove themselves or other listeners and with a ReadWriteLock that would trigger a deadlock.
- 
loggerThe Logger implementation with which this Container is associated.
- 
logNameAssociated logger name.
- 
clusterThe cluster with which this Container is associated.
- 
nameThe human-readable name of this Container.
- 
parentThe parent Container to which this Container is a child.
- 
parentClassLoaderThe parent class loader to be configured when we install a Loader.
- 
pipelineThe Pipeline object with which this Container is associated.
- 
smThe string manager for this package.
- 
startChildrenprotected boolean startChildrenWill children be started automatically when they are added.
- 
supportThe property change support for this component.
- 
accessLogThe access log to use for requests normally handled by this container that have been handled earlier in the processing chain.
- 
startStopExecutor
 
- 
- 
Constructor Details- 
ContainerBasepublic ContainerBase()
 
- 
- 
Method Details- 
getStartStopThreadspublic int getStartStopThreads()Description copied from interface:ContainerObtain the number of threads available for starting and stopping any children associated with this container. This allows start/stop calls to children to be processed in parallel.- Specified by:
- getStartStopThreadsin interface- Container
- Returns:
- The currently configured number of threads used to start/stop children associated with this container
 
- 
setStartStopThreadspublic void setStartStopThreads(int startStopThreads) Description copied from interface:ContainerSets the number of threads available for starting and stopping any children associated with this container. This allows start/stop calls to children to be processed in parallel.- Specified by:
- setStartStopThreadsin interface- Container
- Parameters:
- startStopThreads- The new number of threads to be used
 
- 
getBackgroundProcessorDelaypublic int getBackgroundProcessorDelay()Get the delay between the invocation of the backgroundProcess method on this container and its children. Child containers will not be invoked if their delay value is not negative (which would mean they are using their own thread). Setting this to a positive value will cause a thread to be spawn. After waiting the specified amount of time, the thread will invoke the executePeriodic method on this container and all its children.- Specified by:
- getBackgroundProcessorDelayin interface- Container
- Returns:
- The delay between the invocation of the backgroundProcess method on this container and its children. A non-positive value indicates that background processing will be managed by the parent.
 
- 
setBackgroundProcessorDelaypublic void setBackgroundProcessorDelay(int delay) Set the delay between the invocation of the execute method on this container and its children.- Specified by:
- setBackgroundProcessorDelayin interface- Container
- Parameters:
- delay- The delay in seconds between the invocation of backgroundProcess methods
 
- 
getLoggerReturn the Logger for this Container.
- 
getLogNameDescription copied from interface:ContainerReturn the logger name that the container will use.- Specified by:
- getLogNamein interface- Container
- Returns:
- the abbreviated name of this container for logging messages
 
- 
getClusterReturn the Cluster with which this Container is associated. If there is no associated Cluster, return the Cluster associated with our parent Container (if any); otherwise returnnull.- Specified by:
- getClusterin interface- Container
- Returns:
- The Cluster with which this Container is associated. If there is
         no associated Cluster, return the Cluster associated with our
         parent Container (if any); otherwise return null.
 
- 
getClusterInternal
- 
setClusterSet the Cluster with which this Container is associated.- Specified by:
- setClusterin interface- Container
- Parameters:
- cluster- The newly associated Cluster
 
- 
getNameReturn a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.
- 
setNameSet a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.- Specified by:
- setNamein interface- Container
- Parameters:
- name- New name of this container
- Throws:
- IllegalStateException- if this Container has already been added to the children of a parent Container (after which the name may not be changed)
 
- 
getStartChildrenpublic boolean getStartChildren()Return if children of this container will be started automatically when they are added to this container.- Returns:
- trueif the children will be started
 
- 
setStartChildrenpublic void setStartChildren(boolean startChildren) Set if children of this container will be started automatically when they are added to this container.- Parameters:
- startChildren- New value of the startChildren flag
 
- 
getParentReturn the Container for which this Container is a child, if there is one. If there is no defined parent, returnnull.
- 
setParentSet the parent Container to which this Container is being added as a child. This Container may refuse to become attached to the specified Container by throwing an exception.- Specified by:
- setParentin interface- Container
- Parameters:
- container- Container to which this Container is being added as a child
- Throws:
- IllegalArgumentException- if this Container refuses to become attached to the specified Container
 
- 
getParentClassLoaderReturn the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.- Specified by:
- getParentClassLoaderin interface- Container
- Returns:
- the parent class loader for this component. If not set, return
         Container.getParent().Container.getParentClassLoader(). If no parent has been set, return the system class loader.
 
- 
setParentClassLoaderSet the parent class loader (if any) for this web application. This call is meaningful only before a Loader has been configured, and the specified value (if non-null) should be passed as an argument to the class loader constructor.- Specified by:
- setParentClassLoaderin interface- Container
- Parameters:
- parent- The new parent class loader
 
- 
getPipelineReturn the Pipeline object that manages the Valves associated with this Container.- Specified by:
- getPipelinein interface- Container
- Returns:
- The Pipeline
 
- 
getRealmReturn the Realm with which this Container is associated. If there is no associated Realm, return the Realm associated with our parent Container (if any); otherwise returnnull.
- 
getRealmInternal
- 
setRealmSet the Realm with which this Container is associated.
- 
addChildAdd a new child Container to those associated with this Container, if supported. Prior to adding this Container to the set of children, the child'ssetParent()method must be called, with this Container as an argument. This method may thrown anIllegalArgumentExceptionif this Container chooses not to be attached to the specified Container, in which case it is not added- Specified by:
- addChildin interface- Container
- Parameters:
- child- New child Container to be added
- Throws:
- IllegalArgumentException- if this exception is thrown by the- setParent()method of the child Container
- IllegalArgumentException- if the new child does not have a name unique from that of existing children of this Container
- IllegalStateException- if this Container does not support child Containers
 
- 
addContainerListenerAdd a container event listener to this component.- Specified by:
- addContainerListenerin interface- Container
- Parameters:
- listener- The listener to add
 
- 
addPropertyChangeListenerAdd a property change listener to this component.- Specified by:
- addPropertyChangeListenerin interface- Container
- Parameters:
- listener- The listener to add
 
- 
findChildReturn the child Container, associated with this Container, with the specified name (if any); otherwise, returnnull
- 
findChildrenReturn the set of children Containers associated with this Container. If this Container has no children, a zero-length array is returned.- Specified by:
- findChildrenin interface- Container
- Returns:
- An array containing all children of this container. If this Container has no children, a zero-length array is returned.
 
- 
findContainerListenersReturn the set of container listeners associated with this Container. If this Container has no registered container listeners, a zero-length array is returned.- Specified by:
- findContainerListenersin interface- Container
- Returns:
- An array containing the container listeners associated with this Container. If this Container has no registered container listeners, a zero-length array is returned.
 
- 
removeChildRemove an existing child Container from association with this parent Container.- Specified by:
- removeChildin interface- Container
- Parameters:
- child- Existing child Container to be removed
 
- 
removeContainerListenerRemove a container event listener from this component.- Specified by:
- removeContainerListenerin interface- Container
- Parameters:
- listener- The listener to remove
 
- 
removePropertyChangeListenerRemove a property change listener from this component.- Specified by:
- removePropertyChangeListenerin interface- Container
- Parameters:
- listener- The listener to remove
 
- 
startInternalStart this component and implement the requirements ofLifecycleBase.startInternal().- Specified by:
- startInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
stopInternalStop this component and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
- stopInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
destroyInternalDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.- Overrides:
- destroyInternalin class- LifecycleMBeanBase
- Throws:
- LifecycleException- If the destruction fails
 
- 
logAccessCheck this container for an access log and if none is found, look to the parent. If there is no parent and still none is found, use the NoOp access log.- Specified by:
- logAccessin interface- Container
- Parameters:
- request- Request (associated with the response) to log
- response- Response (associated with the request) to log
- time- Time taken to process the request/response in milliseconds (use 0 if not known)
- useDefault- Flag that indicates that the request/response should be logged in the engine's default access log
 
- 
getAccessLogDescription copied from interface:ContainerObtain the AccessLog to use to log a request/response that is destined for this container. This is typically used when the request/response was handled (and rejected) earlier in the processing chain so that the request/response still appears in the correct access logs.- Specified by:
- getAccessLogin interface- Container
- Returns:
- The AccessLog to use for a request/response destined for this container
 
- 
addValveConvenience method, intended for use by the digester to simplify the process of adding Valves to containers. SeePipeline.addValve(Valve)for full details. Components other than the digester should usegetPipeline().addValve(Valve)in case a future implementation provides an alternative method for the digester to use.- Parameters:
- valve- Valve to be added
- Throws:
- IllegalArgumentException- if this Container refused to accept the specified Valve
- IllegalArgumentException- if the specified Valve refuses to be associated with this Container
- IllegalStateException- if the specified Valve is already associated with a different Container
 
- 
backgroundProcesspublic void backgroundProcess()Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.- Specified by:
- backgroundProcessin interface- Container
 
- 
getCatalinaBaseDescription copied from interface:ContainerObtain the location of CATALINA_BASE.- Specified by:
- getCatalinaBasein interface- Container
- Returns:
- The location of CATALINA_BASE.
 
- 
getCatalinaHomeDescription copied from interface:ContainerObtain the location of CATALINA_HOME.- Specified by:
- getCatalinaHomein interface- Container
- Returns:
- The location of CATALINA_HOME.
 
- 
fireContainerEventNotify all container event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.- Specified by:
- fireContainerEventin interface- Container
- Parameters:
- type- Event type
- data- Event data
 
- 
getDomainInternalDescription copied from class:LifecycleMBeanBaseMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Specified by:
- getDomainInternalin class- LifecycleMBeanBase
- Returns:
- The name of the domain to use to register MBeans.
 
- 
getMBeanKeyPropertiesDescription copied from interface:ContainerCalculate the key properties string to be added to an object'sObjectNameto indicate that it is associated with this container.- Specified by:
- getMBeanKeyPropertiesin interface- Container
- Returns:
- A string suitable for appending to the ObjectName
 
- 
getChildren
- 
threadStartprotected void threadStart()Start the background thread that will periodically check for session timeouts.
- 
threadStopprotected void threadStop()Stop the background thread that is periodically checking for session timeouts.
- 
toString
 
-