org.apache.catalina

Interface Server

All Known Implementing Classes:

StandardServer

public interface Server

A Server element represents the entire Catalina servlet container. Its attributes represent the characteristics of the servlet container as a whole. A Server may contain one or more Services, and the top level set of naming resources.

Normally, an implementation of this interface will also implement Lifecycle, such that when the start() and stop() methods are called, all of the defined Services are also started or stopped.

In between, the implementation must open a server socket on the port number specified by the port property. When a connection is accepted, the first line is read and compared with the specified shutdown command. If the command matches, shutdown of the server is initiated.

NOTE - The concrete implementation of this class should register the (singleton) instance with the ServerFactory class in its constructor(s).

Version:

$Revision: 1433 $ $Date: 2010-04-09 00:33:40 +0200 (Fri, 09 Apr 2010) $

Author:

Craig R. McClanahan

Method Summary

Modifier and Type	Method and Description
void	addService(Service service) Add a new Service to the set of defined Services.
Service	findService(String name) Return the specified Service (if it exists); otherwise return null.
Service[]	findServices() Return the set of Services defined within this Server.
String	getInfo() Return descriptive information about this Server implementation and the corresponding version number, in the format <description>/<version>.
void	initialize() Invoke a pre-startup initialization.
void	removeService(Service service) Remove the specified Service from the set associated from this Server.

Method Detail

getInfo

String getInfo()

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

addService

void addService(Service service)

Add a new Service to the set of defined Services.

Parameters:

service - The Service to be added

findService

Service findService(String name)

Return the specified Service (if it exists); otherwise return null.

Parameters:

name - Name of the Service to be returned

findServices

Service[] findServices()

Return the set of Services defined within this Server.

removeService

void removeService(Service service)

Remove the specified Service from the set associated from this Server.

Parameters:

service - The Service 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.