Apache Tomcat 6.0.41

org.apache.catalina
Interface Service

All Known Implementing Classes:
Catalina, Embedded, 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.

Author:
Craig R. McClanahan

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
 Connector[] findConnectors()
          Find and return the set of Connectors associated with this Service.
 Executor[] findExecutors()
          Retrieves all executors
 Container getContainer()
          Return the Container that handles requests for all Connectors associated with this Service.
 Executor getExecutor(java.lang.String name)
          Retrieves executor by name, null if not found
 java.lang.String getInfo()
          Return descriptive information about this Service implementation and the corresponding version number, in the format <description>/<version>.
 java.lang.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 removeExecutor(Executor ex)
          Removes an executor from the service
 void setContainer(Container container)
          Set the Container that handles requests for all Connectors associated with this Service.
 void setName(java.lang.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

java.lang.String getInfo()
Return descriptive information about this Service implementation and the corresponding version number, in the format <description>/<version>.


getName

java.lang.String getName()
Return the name of this Service.


setName

void setName(java.lang.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

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)
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

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.

addExecutor

void addExecutor(Executor ex)
Adds a named executor to the service

Parameters:
ex - Executor

findExecutors

Executor[] findExecutors()
Retrieves all executors

Returns:
Executor[]

getExecutor

Executor getExecutor(java.lang.String name)
Retrieves executor by name, null if not found

Parameters:
name - String
Returns:
Executor

removeExecutor

void removeExecutor(Executor ex)
Removes an executor from the service

Parameters:
ex - Executor

Apache Tomcat 6.0.41

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.