org.apache.catalina.core

Class StandardService

public class StandardService extends Object implements Lifecycle, Service, MBeanRegistration

Standard implementation of the Service interface. The associated Container is generally an instance of Engine, but this is not required.

Author: Craig R. McClanahan

Field Summary
protected Connector[]	connectors The set of Connectors associated with this Service.
protected Container	container The Container associated with this Service.
protected ObjectName	controller
protected String	domain
protected ArrayList<Executor>	executors
protected boolean	initialized Has this component been initialized?
protected MBeanServer	mserver
protected ObjectName	oname
protected String	suffix
protected PropertyChangeSupport	support The property change support for this component.
protected String	type

Method Summary
void	addConnector(Connector connector) Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.
void	addExecutor(Executor ex) Adds a named executor to the service
void	addLifecycleListener(LifecycleListener listener) Add a LifecycleEvent listener to this component.
void	addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener to this component.
void	destroy()
Connector[]	findConnectors() Find and return the set of Connectors associated with this Service.
Executor[]	findExecutors() Retrieves all executors
LifecycleListener[]	findLifecycleListeners() Get the lifecycle listeners associated with this lifecycle.
ObjectName[]	getConnectorNames()
Container	getContainer() Return the `Container` that handles requests for all `Connectors` associated with this Service.
ObjectName	getContainerName()
String	getDomain()
Executor	getExecutor(String name) Retrieves executor by name, null if not found
String	getInfo() Return descriptive information about this Service implementation and the corresponding version number, in the format `<description>/<version>`.
String	getName() Return the name of this Service.
ObjectName	getObjectName()
Server	getServer() Return the `Server` with which we are associated (if any).
void	init()
void	initialize() Invoke a pre-startup initialization.
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
void	removeConnector(Connector connector) Remove the specified Connector from the set associated from this Service.
void	removeExecutor(Executor ex) Removes an executor from the service
void	removeLifecycleListener(LifecycleListener listener) Remove a LifecycleEvent listener from this component.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a property change listener from this component.
void	setContainer(Container container) Set the `Container` that handles requests for all `Connectors` associated with this Service.
void	setName(String name) Set the name of this Service.
void	setServer(Server server) Set the `Server` with which we are associated (if any).
void	start() Prepare for the beginning of active use of the public methods of this component.
void	stop() Gracefully terminate the active use of the public methods of this component.
String	toString() Return a String representation of this component.

Field Detail

connectors

protected Connector[] connectors

The set of Connectors associated with this Service.

container

protected Container container

The Container associated with this Service. (In the case of the org.apache.catalina.startup.Embedded subclass, this holds the most recently added Engine.)

initialized

protected boolean initialized

Has this component been initialized?

support

protected PropertyChangeSupport support

The property change support for this component.

Method Detail

addConnector

public void addConnector(Connector connector)

Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.

Parameters: connector The Connector to be added

addExecutor

public void addExecutor(Executor ex)

Adds a named executor to the service

Parameters: ex Executor

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Add a LifecycleEvent listener to this component.

Parameters: listener The listener to add

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener to this component.

Parameters: listener The listener to add

findConnectors

public Connector[] findConnectors()

Find and return the set of Connectors associated with this Service.

findExecutors

public Executor[] findExecutors()

Retrieves all executors

Returns: Executor[]

findLifecycleListeners

public LifecycleListener[] findLifecycleListeners()

Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.

getContainer

public Container getContainer()

Return the Container that handles requests for all Connectors associated with this Service.

getExecutor

public Executor getExecutor(String name)

Retrieves executor by name, null if not found

Parameters: name String

Returns: Executor

getInfo

public String getInfo()

Return descriptive information about this Service implementation and the corresponding version number, in the format <description>/<version>.

getName

public String getName()

Return the name of this Service.

getServer

public Server getServer()

Return the Server with which we are associated (if any).

initialize

public void initialize()

Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.

postRegister

public void postRegister(Boolean registrationDone)

preRegister

public ObjectName preRegister(MBeanServer server, ObjectName name)

removeConnector

public void removeConnector(Connector connector)

Remove the specified Connector from the set associated from this Service. The removed Connector will also be disassociated from our Container.

Parameters: connector The Connector to be removed

removeExecutor

public void removeExecutor(Executor ex)

Removes an executor from the service

Parameters: ex Executor

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Remove a LifecycleEvent listener from this component.

Parameters: listener The listener to remove

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a property change listener from this component.

Parameters: listener The listener to remove

setContainer

public void setContainer(Container container)

Set the Container that handles requests for all Connectors associated with this Service.

Parameters: container The new Container

setName

public void setName(String name)

Set the name of this Service.

Parameters: name The new service name

setServer

public void setServer(Server server)

Set the Server with which we are associated (if any).

Parameters: server The server that owns this Service

Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.

Throws: LifecycleException if this component detects a fatal error that prevents this component from being used

stop

public void stop()

Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component. It should also send a LifecycleEvent of type STOP_EVENT to any registered listeners.

Throws: LifecycleException if this component detects a fatal error that needs to be reported

toString

public String toString()

Return a String representation of this component.