Package org.apache.catalina.core
Class StandardServer
- java.lang.Object
-
- org.apache.catalina.core.StandardServer
-
-
Field Summary
-
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENT
-
-
Constructor Summary
Constructors Constructor Description StandardServer()
Construct a default instance of this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.void
addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.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.List<LifecycleListener>
findLifecycleListeners()
Gets the (possibly empty) list of lifecycle listeners associated with this StandardServer.Service
findService(String name)
Return the specified Service (if it exists); otherwise returnnull
.Service[]
findServices()
Return the set of Services defined within this Server.int
getDebug()
Return the debugging detail level.String
getDomain()
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>
.ObjectName
getObjectName()
int
getPort()
Return the port number we listen to for shutdown commands.ObjectName[]
getServiceNames()
String
getShutdown()
Return the shutdown command string we are waiting for.void
init()
void
initialize()
Invoke a pre-startup initialization.void
removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.void
removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.void
removeService(Service service)
Remove the specified Service from the set associated from this Server.void
setDebug(int debug)
Set the debugging detail level.void
setGlobalNamingContext(Context globalNamingContext)
Set the global naming resources context.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.void
start()
Prepare for the beginning of active use of the public methods of this component.void
stop()
Gracefully terminate the active use of the public methods of this component.String
toString()
Return a String representation of this component.
-
-
-
Method Detail
-
getDebug
public int getDebug()
Return the debugging detail level.
-
setDebug
public void setDebug(int debug)
Set the debugging detail level.- Parameters:
debug
- The new debugging detail level
-
getGlobalNamingContext
public Context getGlobalNamingContext()
Return the global naming resources context.
-
setGlobalNamingContext
public void setGlobalNamingContext(Context globalNamingContext)
Set the global naming resources context.- Parameters:
globalNamingContext
- The new global naming resource context
-
getGlobalNamingResources
public NamingResources getGlobalNamingResources()
Return the global naming resources.- Specified by:
getGlobalNamingResources
in interfaceServer
-
setGlobalNamingResources
public void setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.- Specified by:
setGlobalNamingResources
in interfaceServer
- Parameters:
globalNamingResources
- The new global naming resources
-
getInfo
public String getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format<description>/<version>
.
-
getPort
public int getPort()
Return the port number we listen to for shutdown commands.
-
setPort
public void setPort(int port)
Set the port number we listen to for shutdown commands.
-
getShutdown
public String getShutdown()
Return the shutdown command string we are waiting for.- Specified by:
getShutdown
in interfaceServer
-
setShutdown
public void setShutdown(String shutdown)
Set the shutdown command we are waiting for.- Specified by:
setShutdown
in interfaceServer
- Parameters:
shutdown
- The new shutdown command
-
addService
public void addService(Service service)
Add a new Service to the set of defined Services.- Specified by:
addService
in interfaceServer
- Parameters:
service
- The Service to be added
-
await
public void await()
Wait until a proper shutdown command is received, then return.
-
findService
public Service findService(String name)
Return the specified Service (if it exists); otherwise returnnull
.- Specified by:
findService
in interfaceServer
- Parameters:
name
- Name of the Service to be returned
-
findServices
public Service[] findServices()
Return the set of Services defined within this Server.- Specified by:
findServices
in interfaceServer
-
getServiceNames
public ObjectName[] getServiceNames()
- Returns:
- the object names of all registered Service instances
-
removeService
public void removeService(Service service)
Remove the specified Service from the set associated from this Server.- Specified by:
removeService
in interfaceServer
- Parameters:
service
- The Service to be removed
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.- Parameters:
listener
- The listener to add
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.- Parameters:
listener
- The listener to remove
-
toString
public String toString()
Return a String representation of this component.
-
addLifecycleListener
public void addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.- Specified by:
addLifecycleListener
in interfaceLifecycle
- Parameters:
listener
- The listener to add
-
findLifecycleListeners
public List<LifecycleListener> findLifecycleListeners()
Gets the (possibly empty) list of lifecycle listeners associated with this StandardServer.- Specified by:
findLifecycleListeners
in interfaceLifecycle
-
removeLifecycleListener
public void removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.- Specified by:
removeLifecycleListener
in interfaceLifecycle
- Parameters:
listener
- The listener to remove
-
start
public void start() throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.- Specified by:
start
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
-
stop
public void stop() throws LifecycleException
Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component. It should also send a LifecycleEvent of type STOP_EVENT to any registered listeners.- Specified by:
stop
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that needs to be reported
-
initialize
public void initialize() throws LifecycleException
Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.- Specified by:
initialize
in interfaceServer
- Throws:
LifecycleException
- If this server was already initialized.
-
getObjectName
public ObjectName getObjectName()
-
getDomain
public String getDomain()
-
-