public interface Server extends Lifecycle
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).
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT| Modifier and Type | Method and 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 return
null. |
Service[] |
findServices()
Return the set of Services defined within this Server.
|
String |
getAddress()
Return the address on which we listen to for shutdown commands.
|
Catalina |
getCatalina()
Return the outer Catalina startup/shutdown component if present.
|
Context |
getGlobalNamingContext()
Return the global naming resources context.
|
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>. |
ClassLoader |
getParentClassLoader()
Return the parent class loader for this component.
|
int |
getPort()
Return the port number we listen to for shutdown commands.
|
String |
getShutdown()
Return the shutdown command string we are waiting for.
|
void |
removeService(Service service)
Remove the specified Service from the set associated from this
Server.
|
void |
setAddress(String address)
Set the address on which we listen to for shutdown commands.
|
void |
setCatalina(Catalina catalina)
Set the outer Catalina startup/shutdown component if present.
|
void |
setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.
|
void |
setParentClassLoader(ClassLoader parent)
Set the parent class loader for this server.
|
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.
|
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stopString getInfo()
<description>/<version>.NamingResources getGlobalNamingResources()
void setGlobalNamingResources(NamingResources globalNamingResources)
globalNamingResources - The new global naming resourcesContext getGlobalNamingContext()
int getPort()
void setPort(int port)
port - The new port numberString getAddress()
void setAddress(String address)
address - The new addressString getShutdown()
void setShutdown(String shutdown)
shutdown - The new shutdown commandClassLoader getParentClassLoader()
getCatalina() Catalina.getParentClassLoader(). If
catalina has not been set, return the system class loader.void setParentClassLoader(ClassLoader parent)
parent - The new parent class loaderCatalina getCatalina()
void setCatalina(Catalina catalina)
void addService(Service service)
service - The Service to be addedvoid await()
Service findService(String name)
null.name - Name of the Service to be returnedService[] findServices()
void removeService(Service service)
service - The Service to be removedCopyright © 2000-2013 Apache Software Foundation. All Rights Reserved.