Package org.apache.catalina
Interface Server
-
- All Known Implementing Classes:
StandardServer
public interface Server
AServer
element represents the entire Catalina servlet container. Its attributes represent the characteristics of the servlet container as a whole. AServer
may contain one or moreServices
, and the top level set of naming resources.Normally, an implementation of this interface will also implement
Lifecycle
, such that when thestart()
andstop()
methods are called, all of the definedServices
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: 1.2 $ $Date: 2005/12/08 01:27:19 $
- Author:
- Craig R. McClanahan
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addService(Service service)
Add a new Service to the set of defined Services.void
await()
Wait until a proper shutdown command is received, then return.Service
findService(String name)
Return the specified Service (if it exists); otherwise returnnull
.Service[]
findServices()
Return the set of Services defined within this Server.NamingResources
getGlobalNamingResources()
Return the global naming resources.String
getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format<description>/<version>
.int
getPort()
Return the port number we listen to for shutdown commands.String
getShutdown()
Return the shutdown command string we are waiting for.void
initialize()
Invoke a pre-startup initialization.void
removeService(Service service)
Remove the specified Service from the set associated from this Server.void
setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.void
setPort(int port)
Set the port number we listen to for shutdown commands.void
setShutdown(String shutdown)
Set the shutdown command we are waiting for.
-
-
-
Method Detail
-
getInfo
String getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format<description>/<version>
.
-
getGlobalNamingResources
NamingResources getGlobalNamingResources()
Return the global naming resources.
-
setGlobalNamingResources
void setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.- Parameters:
globalNamingResources
- The new global naming resources
-
getPort
int getPort()
Return the port number we listen to for shutdown commands.
-
setPort
void setPort(int port)
Set the port number we listen to for shutdown commands.- Parameters:
port
- The new port number
-
getShutdown
String getShutdown()
Return the shutdown command string we are waiting for.
-
setShutdown
void setShutdown(String shutdown)
Set the shutdown command we are waiting for.- Parameters:
shutdown
- The new shutdown command
-
addService
void addService(Service service)
Add a new Service to the set of defined Services.- Parameters:
service
- The Service to be added
-
await
void await()
Wait until a proper shutdown command is received, then return.
-
findService
Service findService(String name)
Return the specified Service (if it exists); otherwise returnnull
.- 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.
-
-