StandardServer (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.catalina.util.LifecycleBase
- - org.apache.catalina.util.LifecycleMBeanBase
  - - org.apache.catalina.core.StandardServer

All Implemented Interfaces:

javax.management.MBeanRegistration, JmxEnabled, Lifecycle, Server
```
public final class StandardServer
extends LifecycleMBeanBase
implements Server
```
Standard implementation of the Server interface, available for use (but not required) when deploying and starting Catalina.

Author:

Craig R. McClanahan

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
  Lifecycle.SingleUse

Field Summary
- Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
  mserver
- Fields inherited from interface org.apache.catalina.Lifecycle
  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

Constructor Summary

Constructors
Constructor and Description

StandardServer()
Construct a default instance of this class.

Constructors
Constructor and Description
`StandardServer()` Construct a default instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.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.
`protected void`	`destroyInternal()` Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
`Service`	`findService(java.lang.String name)` Return the specified Service (if it exists); otherwise return `null`.
`Service[]`	`findServices()` Return the set of Services defined within this Server.
`java.lang.String`	`getAddress()` Return the address on which we listen to for shutdown commands.
`Catalina`	`getCatalina()` Return the outer Catalina startup/shutdown component if present.
`java.io.File`	`getCatalinaBase()`
`java.io.File`	`getCatalinaHome()`
`protected java.lang.String`	`getDomainInternal()` Obtain the MBean domain for this server.
`javax.naming.Context`	`getGlobalNamingContext()` Return the global naming resources context.
`NamingResourcesImpl`	`getGlobalNamingResources()` Return the global naming resources.
`java.lang.Object`	`getNamingToken()`
`protected java.lang.String`	`getObjectNameKeyProperties()` Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
`java.lang.ClassLoader`	`getParentClassLoader()` Return the parent class loader for this component.
`int`	`getPort()` Return the port number we listen to for shutdown commands.
`java.lang.String`	`getServerBuilt()` Return the current server built timestamp
`java.lang.String`	`getServerInfo()` Report the current Tomcat Server Release number
`java.lang.String`	`getServerNumber()` Return the current server's version number.
`javax.management.ObjectName[]`	`getServiceNames()` Return the JMX service names.
`java.lang.String`	`getShutdown()` Return the shutdown command string we are waiting for.
`protected void`	`initInternal()` Invoke a pre-startup initialization.
`void`	`removePropertyChangeListener(java.beans.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`	`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`	`setCatalinaBase(java.io.File catalinaBase)` Set the configured base (instance) directory.
`void`	`setCatalinaHome(java.io.File catalinaHome)` Set the configured home (binary) directory.
`void`	`setGlobalNamingContext(javax.naming.Context globalNamingContext)` Set the global naming resources context.
`void`	`setGlobalNamingResources(NamingResourcesImpl 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.
`protected void`	`startInternal()` Start nested components (`Service`s) and implement the requirements of `LifecycleBase.startInternal()`.
`void`	`stopAwait()`
`protected void`	`stopInternal()` Stop nested components (`Service`s) and implement the requirements of `LifecycleBase.stopInternal()`.
`void`	`storeConfig()` Write the configuration information for this entire `Server` out to the server.xml configuration file.
`void`	`storeContext(Context context)` Write the configuration information for `Context` out to the specified configuration file.
`java.lang.String`	`toString()` Return a String representation of this component.

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop

- Constructor Detail
  - StandardServer
```
public StandardServer()
```
    Construct a default instance of this class.
- Method Detail
  - getNamingToken
```
public java.lang.Object getNamingToken()
```
    Specified by:
    
    getNamingToken in interface Server
    
    Returns:
    the token necessary for operations on the associated JNDI naming context.
  - getGlobalNamingContext
```
public javax.naming.Context getGlobalNamingContext()
```
    Return the global naming resources context.
    
    Specified by:
    
    getGlobalNamingContext in interface Server
    
    Returns:
    the global naming resources context.
  - setGlobalNamingContext
```
public void setGlobalNamingContext(javax.naming.Context globalNamingContext)
```
    Set the global naming resources context.
    
    Parameters:
    globalNamingContext - The new global naming resource context
  - getGlobalNamingResources
```
public NamingResourcesImpl getGlobalNamingResources()
```
    Return the global naming resources.
    
    Specified by:
    
    getGlobalNamingResources in interface Server
    
    Returns:
    the global naming resources.
  - setGlobalNamingResources
```
public void setGlobalNamingResources(NamingResourcesImpl globalNamingResources)
```
    Set the global naming resources.
    
    Specified by:
    
    setGlobalNamingResources in interface Server
    
    Parameters:
    globalNamingResources - The new global naming resources
  - getServerInfo
```
public java.lang.String getServerInfo()
```
    Report the current Tomcat Server Release number
    
    Returns:
    Tomcat release identifier
  - getServerBuilt
```
public java.lang.String getServerBuilt()
```
    Return the current server built timestamp
    
    Returns:
    server built timestamp.
  - getServerNumber
```
public java.lang.String getServerNumber()
```
    Return the current server's version number.
    
    Returns:
    server's version number.
  - getPort
```
public int getPort()
```
    Return the port number we listen to for shutdown commands.
    
    Specified by:
    
    getPort in interface Server
    
    Returns:
    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.
    
    Specified by:
    
    setPort in interface Server
    
    Parameters:
    port - The new port number
  - getAddress
```
public java.lang.String getAddress()
```
    Return the address on which we listen to for shutdown commands.
    
    Specified by:
    
    getAddress in interface Server
    
    Returns:
    the address on which we listen to for shutdown commands.
  - setAddress
```
public void setAddress(java.lang.String address)
```
    Set the address on which we listen to for shutdown commands.
    
    Specified by:
    
    setAddress in interface Server
    
    Parameters:
    address - The new address
  - getShutdown
```
public java.lang.String getShutdown()
```
    Return the shutdown command string we are waiting for.
    
    Specified by:
    
    getShutdown in interface Server
    
    Returns:
    the shutdown command string we are waiting for.
  - setShutdown
```
public void setShutdown(java.lang.String shutdown)
```
    Set the shutdown command we are waiting for.
    
    Specified by:
    
    setShutdown in interface Server
    
    Parameters:
    shutdown - The new shutdown command
  - getCatalina
```
public Catalina getCatalina()
```
    Return the outer Catalina startup/shutdown component if present.
    
    Specified by:
    
    getCatalina in interface Server
    
    Returns:
    the outer Catalina startup/shutdown component if present.
  - setCatalina
```
public void setCatalina(Catalina catalina)
```
    Set the outer Catalina startup/shutdown component if present.
    
    Specified by:
    
    setCatalina in interface Server
    
    Parameters:
    catalina - the outer Catalina component
  - addService
```
public void addService(Service service)
```
    Add a new Service to the set of defined Services.
    
    Specified by:
    
    addService in interface Server
    
    Parameters:
    service - The Service to be added
  - stopAwait
```
public void stopAwait()
```
  - await
```
public void await()
```
    Wait until a proper shutdown command is received, then return. This keeps the main thread alive - the thread pool listening for http connections is daemon threads.
    
    Specified by:
    
    await in interface Server
  - findService
```
public Service findService(java.lang.String name)
```
    Return the specified Service (if it exists); otherwise return null.
    
    Specified by:
    
    findService in interface Server
    
    Parameters:
    name - Name of the Service to be returned
    
    Returns:
    the specified Service, or null if none exists.
  - findServices
```
public Service[] findServices()
```
    Return the set of Services defined within this Server.
    
    Specified by:
    
    findServices in interface Server
    
    Returns:
    the set of Services defined within this Server.
  - getServiceNames
```
public javax.management.ObjectName[] getServiceNames()
```
    Return the JMX service names.
  - removeService
```
public void removeService(Service service)
```
    Remove the specified Service from the set associated from this Server.
    
    Specified by:
    
    removeService in interface Server
    
    Parameters:
    service - The Service to be removed
  - getCatalinaBase
```
public java.io.File getCatalinaBase()
```
    Specified by:
    
    getCatalinaBase in interface Server
    
    Returns:
    the configured base (instance) directory. Note that home and base may be the same (and are by default). If this is not set the value returned by Server.getCatalinaHome() will be used.
  - setCatalinaBase
```
public void setCatalinaBase(java.io.File catalinaBase)
```
    Description copied from interface: Server
    
    Set the configured base (instance) directory. Note that home and base may be the same (and are by default).
    
    Specified by:
    
    setCatalinaBase in interface Server
    
    Parameters:
    catalinaBase - the configured base directory
  - getCatalinaHome
```
public java.io.File getCatalinaHome()
```
    Specified by:
    
    getCatalinaHome in interface Server
    
    Returns:
    the configured home (binary) directory. Note that home and base may be the same (and are by default).
  - setCatalinaHome
```
public void setCatalinaHome(java.io.File catalinaHome)
```
    Description copied from interface: Server
    
    Set the configured home (binary) directory. Note that home and base may be the same (and are by default).
    
    Specified by:
    
    setCatalinaHome in interface Server
    
    Parameters:
    catalinaHome - the configured home directory
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Add a property change listener to this component.
    
    Parameters:
    listener - The listener to add
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Remove a property change listener from this component.
    
    Parameters:
    listener - The listener to remove
  - toString
```
public java.lang.String toString()
```
    Return a String representation of this component.
    
    Overrides:
    
    toString in class java.lang.Object
  - storeConfig
```
public void storeConfig()
                 throws java.lang.Exception
```
    Write the configuration information for this entire Server out to the server.xml configuration file.
    
    Throws:
    
    javax.management.InstanceNotFoundException - if the managed resource object cannot be found
    
    javax.management.MBeanException - if the initializer of the object throws an exception, or persistence is not supported
    
    javax.management.RuntimeOperationsException - if an exception is reported by the persistence mechanism
    
    java.lang.Exception
  - storeContext
```
public void storeContext(Context context)
                  throws java.lang.Exception
```
    Write the configuration information for Context out to the specified configuration file.
    
    Throws:
    
    javax.management.InstanceNotFoundException - if the managed resource object cannot be found
    
    javax.management.MBeanException - if the initializer of the object throws an exception, or persistence is not supported
    
    javax.management.RuntimeOperationsException - if an exception is reported by the persistence mechanism
    
    java.lang.Exception
  - startInternal
```
protected void startInternal()
                      throws LifecycleException
```
    Start nested components (Services) and implement the requirements of LifecycleBase.startInternal().
    
    Specified by:
    
    startInternal in class LifecycleBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used
  - stopInternal
```
protected void stopInternal()
                     throws LifecycleException
```
    Stop nested components (Services) and implement the requirements of LifecycleBase.stopInternal().
    
    Specified by:
    
    stopInternal in class LifecycleBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that needs to be reported
  - initInternal
```
protected void initInternal()
                     throws LifecycleException
```
    Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.
    
    Overrides:
    
    initInternal in class LifecycleMBeanBase
    
    Throws:
    
    LifecycleException
  - destroyInternal
```
protected void destroyInternal()
                        throws LifecycleException
```
    Description copied from class: LifecycleMBeanBase
    
    Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
    
    Overrides:
    
    destroyInternal in class LifecycleMBeanBase
    
    Throws:
    
    LifecycleException
  - getParentClassLoader
```
public java.lang.ClassLoader getParentClassLoader()
```
    Return the parent class loader for this component.
    
    Specified by:
    
    getParentClassLoader in interface Server
    
    Returns:
    the parent class loader for this component. If not set, return Server.getCatalina() Catalina.getParentClassLoader(). If catalina has not been set, return the system class loader.
  - setParentClassLoader
```
public void setParentClassLoader(java.lang.ClassLoader parent)
```
    Set the parent class loader for this server.
    
    Specified by:
    
    setParentClassLoader in interface Server
    
    Parameters:
    parent - The new parent class loader
  - getDomainInternal
```
protected java.lang.String getDomainInternal()
```
    Obtain the MBean domain for this server. The domain is obtained using the following search order:
    1. Name of first Engine.
    2. Name of first Service.
    Specified by:
    
    getDomainInternal in class LifecycleMBeanBase
    
    Returns:
    The name of the domain to use to register MBeans.
  - getObjectNameKeyProperties
```
protected final java.lang.String getObjectNameKeyProperties()
```
    Description copied from class: LifecycleMBeanBase
    
    Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
    
    Specified by:
    
    getObjectNameKeyProperties in class LifecycleMBeanBase
    
    Returns:
    The string representation of the key properties component of the desired ObjectName

Class StandardServer

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Field Summary

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

Methods inherited from class org.apache.catalina.util.LifecycleBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.catalina.Lifecycle

Constructor Detail

StandardServer

Method Detail

getNamingToken

getGlobalNamingContext

setGlobalNamingContext

getGlobalNamingResources

setGlobalNamingResources

getServerInfo

getServerBuilt

getServerNumber

getPort

setPort

getAddress

setAddress

getShutdown

setShutdown

getCatalina

setCatalina

addService

stopAwait

await

findService

findServices

getServiceNames

removeService

getCatalinaBase

setCatalinaBase

getCatalinaHome

setCatalinaHome

addPropertyChangeListener

removePropertyChangeListener

toString

storeConfig

storeContext

startInternal

stopInternal

initInternal

destroyInternal

getParentClassLoader

setParentClassLoader

getDomainInternal

getObjectNameKeyProperties