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).
Lifecycle.SingleUse
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(java.lang.String name)
Find the specified Service
|
Service[] |
findServices() |
java.lang.String |
getAddress() |
Catalina |
getCatalina() |
javax.naming.Context |
getGlobalNamingContext() |
NamingResources |
getGlobalNamingResources() |
java.lang.String |
getInfo() |
java.lang.ClassLoader |
getParentClassLoader() |
int |
getPort() |
java.lang.String |
getShutdown() |
void |
removeService(Service service)
Remove the specified Service from the set associated from this
Server.
|
void |
setAddress(java.lang.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(java.lang.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(java.lang.String shutdown)
Set the shutdown command we are waiting for.
|
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
java.lang.String getInfo()
<description>/<version>
.NamingResources getGlobalNamingResources()
void setGlobalNamingResources(NamingResources globalNamingResources)
globalNamingResources
- The new global naming resourcesjavax.naming.Context getGlobalNamingContext()
int getPort()
void setPort(int port)
port
- The new port numberjava.lang.String getAddress()
void setAddress(java.lang.String address)
address
- The new addressjava.lang.String getShutdown()
void setShutdown(java.lang.String shutdown)
shutdown
- The new shutdown commandjava.lang.ClassLoader getParentClassLoader()
getCatalina()
Catalina.getParentClassLoader()
. If
catalina has not been set, return the system class loader.void setParentClassLoader(java.lang.ClassLoader parent)
parent
- The new parent class loaderCatalina getCatalina()
void setCatalina(Catalina catalina)
catalina
- the outer Catalina componentvoid addService(Service service)
service
- The Service to be addedvoid await()
Service findService(java.lang.String name)
name
- Name of the Service to be returnednull
if none exists.Service[] findServices()
void removeService(Service service)
service
- The Service to be removedCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.