org.apache.catalina.mbeans
Class ServerLifecycleListener

java.lang.Object
  org.apache.catalina.mbeans.ServerLifecycleListener

All Implemented Interfaces:

PropertyChangeListener, EventListener, ContainerListener, LifecycleListener

public class ServerLifecycleListener
extends Object
implements ContainerListener, LifecycleListener, PropertyChangeListener

Implementation of LifecycleListener that instantiates the set of MBeans associated with the components of a running instance of Catalina.

Version:

$Id: ServerLifecycleListener.java 1002556 2010-09-29 10:07:10Z markt $ TODO: Is this still required? Possibly for resources. Need to check.

Author:

Craig R. McClanahan, Amy Roh

Field Summary

protected String

descriptors Semicolon separated list of paths containing MBean descriptor resources.

Constructor Summary

ServerLifecycleListener()

Method Summary

void	containerEvent(ContainerEvent event) Handle a ContainerEvent from one of the Containers we are interested in.
protected void	createMBeans(Connector connector) Create the MBeans for the specified Connector and its nested components.
protected void	createMBeans(Context context) Create the MBeans for the specified Context and its nested components.
protected void	createMBeans(ContextEnvironment environment) Create the MBeans for the specified ContextEnvironment entry.
protected void	createMBeans(ContextResource resource) Create the MBeans for the specified ContextResource entry.
protected void	createMBeans(ContextResourceLink resourceLink) Create the MBeans for the specified ContextResourceLink entry.
protected void	createMBeans(Engine engine) Create the MBeans for the specified Engine and its nested components.
protected void	createMBeans(Host host) Create the MBeans for the specified Host and its nested components.
protected void	createMBeans(MBeanFactory factory) Create the MBeans for MBeanFactory.
protected void	createMBeans(NamingResources resources) Create the MBeans for the specified NamingResources and its nested components.
protected void	createMBeans(Server server) Create the MBeans for the specified Server and its nested components.
protected void	createMBeans(Service service) Create the MBeans for the specified Service and its nested components.
protected void	destroyMBeans(Connector connector, Service service) Deregister the MBeans for the specified Connector and its nested components.
protected void	destroyMBeans(Context context) Deregister the MBeans for the specified Context and its nested components.
protected void	destroyMBeans(ContextEnvironment environment) Deregister the MBeans for the specified ContextEnvironment entry.
protected void	destroyMBeans(ContextResource resource) Deregister the MBeans for the specified ContextResource entry.
protected void	destroyMBeans(ContextResourceLink resourceLink) Deregister the MBeans for the specified ContextResourceLink entry.
protected void	destroyMBeans(Engine engine) Deregister the MBeans for the specified Engine and its nested components.
protected void	destroyMBeans(Host host) Deregister the MBeans for the specified Host and its nested components.
protected void	destroyMBeans(NamingResources resources) Deregister the MBeans for the specified NamingResources and its nested components.
protected void	destroyMBeans(Server server) Deregister the MBeans for the specified Server and its related components.
protected void	destroyMBeans(Service service) Deregister the MBeans for the specified Service and its nested components.
String	getDescriptors()
void	lifecycleEvent(LifecycleEvent event) Primary entry point for startup and shutdown events.
protected void	processContainerAddChild(Container parent, Container child) Process the addition of a new child Container to a parent Container.
protected void	processContainerPropertyChange(Container container, String propertyName, Object oldValue, Object newValue) Process a property change event on a Container.
protected void	processContainerRemoveChild(Container parent, Container child) Process the removal of a child Container from a parent Container.
protected void	processNamingResourcesPropertyChange(NamingResources resources, String propertyName, Object oldValue, Object newValue) Process a property change event on a NamingResources.
protected void	processServerPropertyChange(Server server, String propertyName, Object oldValue, Object newValue) Process a property change event on a Server.
protected void	processServicePropertyChange(Service service, String propertyName, Object oldValue, Object newValue) Process a property change event on a Service.
void	propertyChange(PropertyChangeEvent event) Handle a PropertyChangeEvent from one of the Containers we are interested in.
void	setDescriptors(String descriptors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

descriptors

protected String descriptors

Semicolon separated list of paths containing MBean descriptor resources.

Constructor Detail

ServerLifecycleListener

public ServerLifecycleListener()

Method Detail

getDescriptors

public String getDescriptors()

setDescriptors

public void setDescriptors(String descriptors)

containerEvent

public void containerEvent(ContainerEvent event)

Handle a ContainerEvent from one of the Containers we are interested in.

Specified by:

containerEvent in interface ContainerListener

Parameters:

event - The event that has occurred

lifecycleEvent

public void lifecycleEvent(LifecycleEvent event)

Primary entry point for startup and shutdown events.

Specified by:

lifecycleEvent in interface LifecycleListener

Parameters:

event - The event that has occurred

propertyChange

public void propertyChange(PropertyChangeEvent event)

Handle a PropertyChangeEvent from one of the Containers we are interested in.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

event - The event that has occurred

createMBeans

protected void createMBeans(Connector connector)
                     throws Exception

Create the MBeans for the specified Connector and its nested components.

Parameters:

connector - Connector for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(Context context)
                     throws Exception

Create the MBeans for the specified Context and its nested components.

Parameters:

context - Context for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(ContextEnvironment environment)
                     throws Exception

Create the MBeans for the specified ContextEnvironment entry.

Parameters:

environment - ContextEnvironment for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(ContextResource resource)
                     throws Exception

Create the MBeans for the specified ContextResource entry.

Parameters:

resource - ContextResource for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(ContextResourceLink resourceLink)
                     throws Exception

Create the MBeans for the specified ContextResourceLink entry.

Parameters:

resourceLink - ContextResourceLink for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(Engine engine)
                     throws Exception

Create the MBeans for the specified Engine and its nested components.

Parameters:

engine - Engine for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(Host host)
                     throws Exception

Create the MBeans for the specified Host and its nested components.

Parameters:

host - Host for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(MBeanFactory factory)
                     throws Exception

Create the MBeans for MBeanFactory.

Parameters:

factory - MBeanFactory for which to create MBean

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(NamingResources resources)
                     throws Exception

Create the MBeans for the specified NamingResources and its nested components.

Parameters:

resources - NamingResources for which to create MBeans

Throws:

Exception

createMBeans

protected void createMBeans(Server server)
                     throws Exception

Create the MBeans for the specified Server and its nested components.

Parameters:

server - Server for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

createMBeans

protected void createMBeans(Service service)
                     throws Exception

Create the MBeans for the specified Service and its nested components.

Parameters:

service - Service for which to create MBeans

Throws:

Exception - if an exception is thrown during MBean creation

destroyMBeans

protected void destroyMBeans(Connector connector,
                             Service service)
                      throws Exception

Deregister the MBeans for the specified Connector and its nested components.

Parameters:

connector - Connector for which to deregister MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(Context context)
                      throws Exception

Deregister the MBeans for the specified Context and its nested components.

Parameters:

context - Context for which to deregister MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(ContextEnvironment environment)
                      throws Exception

Deregister the MBeans for the specified ContextEnvironment entry.

Parameters:

environment - ContextEnvironment for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(ContextResource resource)
                      throws Exception

Deregister the MBeans for the specified ContextResource entry.

Parameters:

resource - ContextResource for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(ContextResourceLink resourceLink)
                      throws Exception

Deregister the MBeans for the specified ContextResourceLink entry.

Parameters:

resourceLink - ContextResourceLink for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(Engine engine)
                      throws Exception

Deregister the MBeans for the specified Engine and its nested components.

Parameters:

engine - Engine for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(Host host)
                      throws Exception

Deregister the MBeans for the specified Host and its nested components.

Parameters:

host - Host for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(NamingResources resources)
                      throws Exception

Deregister the MBeans for the specified NamingResources and its nested components.

Parameters:

resources - NamingResources for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(Server server)
                      throws Exception

Deregister the MBeans for the specified Server and its related components.

Parameters:

server - Server for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

destroyMBeans

protected void destroyMBeans(Service service)
                      throws Exception

Deregister the MBeans for the specified Service and its nested components.

Parameters:

service - Service for which to destroy MBeans

Throws:

Exception - if an exception is thrown during MBean destruction

processContainerAddChild

protected void processContainerAddChild(Container parent,
                                        Container child)

Process the addition of a new child Container to a parent Container.

Parameters:

parent - Parent container

child - Child container

processContainerPropertyChange

protected void processContainerPropertyChange(Container container,
                                              String propertyName,
                                              Object oldValue,
                                              Object newValue)
                                       throws Exception

Process a property change event on a Container.

Parameters:

container - The container on which this event occurred

propertyName - The name of the property that changed

oldValue - The previous value (may be null)

newValue - The new value (may be null)

Throws:

Exception - if an exception is thrown

processContainerRemoveChild

protected void processContainerRemoveChild(Container parent,
                                           Container child)

Process the removal of a child Container from a parent Container.

Parameters:

parent - Parent container

child - Child container

processNamingResourcesPropertyChange

protected void processNamingResourcesPropertyChange(NamingResources resources,
                                                    String propertyName,
                                                    Object oldValue,
                                                    Object newValue)
                                             throws Exception

Process a property change event on a NamingResources.

Parameters:

resources - The global naming resources on which this event occurred

propertyName - The name of the property that changed

oldValue - The previous value (may be null)

newValue - The new value (may be null)

Throws:

Exception - if an exception is thrown

processServerPropertyChange

protected void processServerPropertyChange(Server server,
                                           String propertyName,
                                           Object oldValue,
                                           Object newValue)
                                    throws Exception

Process a property change event on a Server.

Parameters:

server - The server on which this event occurred

propertyName - The name of the property that changed

oldValue - The previous value (may be null)

newValue - The new value (may be null)

Throws:

Exception - if an exception is thrown

processServicePropertyChange

protected void processServicePropertyChange(Service service,
                                            String propertyName,
                                            Object oldValue,
                                            Object newValue)
                                     throws Exception

Process a property change event on a Service.

Parameters:

service - The service on which this event occurred

propertyName - The name of the property that changed

oldValue - The previous value (may be null)

newValue - The new value (may be null)

Throws:

Exception - if an exception is thrown