org.apache.catalina

Interface Service

All Known Implementing Classes:

Catalina, Embedded, EmbeddedWebContainer, StandardService

public interface Service

A Service is a group of one or more Connectors that share a single Container to process their incoming requests. This arrangement allows, for example, a non-SSL and SSL connector to share the same population of web apps.

A given JVM can contain any number of Service instances; however, they are completely independent of each other and share only the basic JVM facilities and classes on the system class path.

Version:

$Revision: 1.2 $ $Date: 2005/12/08 01:27:20 $

Author:

Craig R. McClanahan

Method Summary

Modifier and Type	Method and Description
void	addConnector(Connector connector) Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.
Connector[]	findConnectors() Find and return the set of Connectors associated with this Service.
NotificationBroadcasterSupport	getBroadcaster() Return the NotificationBroadcasterSupport that sends notification for this Service.
Container	getContainer() Return the Container that handles requests for all Connectors associated with this Service.
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.
Server	getServer() Return the Server with which we are associated (if any).
void	initialize() Invoke a pre-startup initialization.
void	removeConnector(Connector connector) Remove the specified Connector from the set associated from this Service.
void	setBroadcaster(NotificationBroadcasterSupport broadcaster) Set the NotificationBroadcasterSupport that sends notification for this Service
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).

Method Detail

getContainer

Container getContainer()

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

setContainer

void setContainer(Container container)

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

Parameters:

container - The new Container

getInfo

String getInfo()

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

getName

String getName()

Return the name of this Service.

setName

void setName(String name)

Set the name of this Service.

Parameters:

name - The new service name

getServer

Server getServer()

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

setServer

void setServer(Server server)

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

Parameters:

server - The server that owns this Service

getBroadcaster

NotificationBroadcasterSupport getBroadcaster()

Return the NotificationBroadcasterSupport that sends notification for this Service.

setBroadcaster

void setBroadcaster(NotificationBroadcasterSupport broadcaster)

Set the NotificationBroadcasterSupport that sends notification for this Service

Parameters:

broadcaster - The new NotificationBroadcasterSupport

addConnector

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

findConnectors

Connector[] findConnectors()

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

removeConnector

void removeConnector(Connector connector)
              throws LifecycleException

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

Throws:

LifecycleException

initialize

void initialize()
         throws LifecycleException

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

Throws:

LifecycleException - If this server was already initialized.