Package org.apache.catalina.core
Class StandardServer
- java.lang.Object
-
- org.apache.catalina.util.LifecycleBase
-
- org.apache.catalina.util.LifecycleMBeanBase
-
- org.apache.catalina.core.StandardServer
-
- All Implemented Interfaces:
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 Modifier and Type Field Description protected intperiodicEventDelayThe lifecycle event period in seconds.protected intutilityThreadsThe number of threads available to process utility tasks in this service.protected booleanutilityThreadsAsDaemonThe utility threads daemon flag.-
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 Description StandardServer()Construct a default instance of this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPropertyChangeListener(PropertyChangeListener listener)Add a property change listener to this component.voidaddService(Service service)Add a new Service to the set of defined Services.voidawait()Wait until a proper shutdown command is received, then return.protected voiddestroyInternal()Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.ServicefindService(String name)Find the specified ServiceService[]findServices()StringgetAddress()Return the address on which we listen to for shutdown commands.CatalinagetCatalina()Return the outer Catalina startup/shutdown component if present.FilegetCatalinaBase()FilegetCatalinaHome()protected StringgetDomainInternal()Obtain the MBean domain for this server.ContextgetGlobalNamingContext()Return the global naming resources context.NamingResourcesImplgetGlobalNamingResources()Return the global naming resources.ObjectgetNamingToken()protected StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.ClassLoadergetParentClassLoader()Return the parent class loader for this component.intgetPeriodicEventDelay()intgetPort()Return the port number we listen to for shutdown commands.intgetPortOffset()Get the number that offsets the port used for shutdown commands.intgetPortWithOffset()Get the actual port on which server is listening for the shutdown commands.StringgetServerBuilt()Return the current server built timestampStringgetServerInfo()Report the current Tomcat Server Release numberStringgetServerNumber()Return the current server's version number.ObjectName[]getServiceNames()StringgetShutdown()Return the shutdown command string we are waiting for.ScheduledExecutorServicegetUtilityExecutor()intgetUtilityThreads()Get the utility thread count.booleangetUtilityThreadsAsDaemon()Get if the utility threads are daemon threads.protected voidinitInternal()Invoke a pre-startup initialization.voidremovePropertyChangeListener(PropertyChangeListener listener)Remove a property change listener from this component.voidremoveService(Service service)Remove the specified Service from the set associated from this Server.voidsetAddress(String address)Set the address on which we listen to for shutdown commands.voidsetCatalina(Catalina catalina)Set the outer Catalina startup/shutdown component if present.voidsetCatalinaBase(File catalinaBase)Set the configured base (instance) directory.voidsetCatalinaHome(File catalinaHome)Set the configured home (binary) directory.voidsetGlobalNamingContext(Context globalNamingContext)Set the global naming resources context.voidsetGlobalNamingResources(NamingResourcesImpl globalNamingResources)Set the global naming resources.voidsetParentClassLoader(ClassLoader parent)Set the parent class loader for this server.voidsetPeriodicEventDelay(int periodicEventDelay)Set the new period between two lifecycle events in seconds.voidsetPort(int port)Set the port number we listen to for shutdown commands.voidsetPortOffset(int portOffset)Set the number that offsets the server port used for shutdown commands.voidsetShutdown(String shutdown)Set the shutdown command we are waiting for.voidsetUtilityThreads(int utilityThreads)Set the utility thread count.voidsetUtilityThreadsAsDaemon(boolean utilityThreadsAsDaemon)Set the utility threads daemon flag.protected voidstartInternal()Start nested components (Services) and implement the requirements ofLifecycleBase.startInternal().protected voidstartPeriodicLifecycleEvent()voidstopAwait()protected voidstopInternal()Stop nested components (Services) and implement the requirements ofLifecycleBase.stopInternal().voidstoreConfig()Write the configuration information for this entireServerout to the server.xml configuration file.voidstoreContext(Context context)Write the configuration information forContextout to the specified configuration file.StringtoString()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, unregister
-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, 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
-
-
-
-
Field Detail
-
utilityThreads
protected int utilityThreads
The number of threads available to process utility tasks in this service.
-
utilityThreadsAsDaemon
protected boolean utilityThreadsAsDaemon
The utility threads daemon flag.
-
periodicEventDelay
protected int periodicEventDelay
The lifecycle event period in seconds.
-
-
Method Detail
-
getNamingToken
public Object getNamingToken()
- Specified by:
getNamingTokenin interfaceServer- Returns:
- the token necessary for operations on the associated JNDI naming context.
-
getGlobalNamingContext
public Context getGlobalNamingContext()
Return the global naming resources context.- Specified by:
getGlobalNamingContextin interfaceServer- Returns:
- 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 NamingResourcesImpl getGlobalNamingResources()
Return the global naming resources.- Specified by:
getGlobalNamingResourcesin interfaceServer- Returns:
- the global naming resources.
-
setGlobalNamingResources
public void setGlobalNamingResources(NamingResourcesImpl globalNamingResources)
Set the global naming resources.- Specified by:
setGlobalNamingResourcesin interfaceServer- Parameters:
globalNamingResources- The new global naming resources
-
getServerInfo
public String getServerInfo()
Report the current Tomcat Server Release number- Returns:
- Tomcat release identifier
-
getServerBuilt
public String getServerBuilt()
Return the current server built timestamp- Returns:
- server built timestamp.
-
getServerNumber
public 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:
getPortin interfaceServer- Returns:
- the port number we listen to for shutdown commands.
- See Also:
Server.getPortOffset(),Server.getPortWithOffset()
-
setPort
public void setPort(int port)
Set the port number we listen to for shutdown commands.- Specified by:
setPortin interfaceServer- Parameters:
port- The new port number- See Also:
Server.setPortOffset(int)
-
getPortOffset
public int getPortOffset()
Description copied from interface:ServerGet the number that offsets the port used for shutdown commands. For example, if port is 8005, and portOffset is 1000, the server listens at 9005.- Specified by:
getPortOffsetin interfaceServer- Returns:
- the port offset
-
setPortOffset
public void setPortOffset(int portOffset)
Description copied from interface:ServerSet the number that offsets the server port used for shutdown commands. For example, if port is 8005, and you set portOffset to 1000, connector listens at 9005.- Specified by:
setPortOffsetin interfaceServer- Parameters:
portOffset- sets the port offset
-
getPortWithOffset
public int getPortWithOffset()
Description copied from interface:ServerGet the actual port on which server is listening for the shutdown commands. If you do not set port offset, port is returned. If you set port offset, port offset + port is returned.- Specified by:
getPortWithOffsetin interfaceServer- Returns:
- the port with offset
-
getAddress
public String getAddress()
Return the address on which we listen to for shutdown commands.- Specified by:
getAddressin interfaceServer- Returns:
- the address on which we listen to for shutdown commands.
-
setAddress
public void setAddress(String address)
Set the address on which we listen to for shutdown commands.- Specified by:
setAddressin interfaceServer- Parameters:
address- The new address
-
getShutdown
public String getShutdown()
Return the shutdown command string we are waiting for.- Specified by:
getShutdownin interfaceServer- Returns:
- the shutdown command string we are waiting for.
-
setShutdown
public void setShutdown(String shutdown)
Set the shutdown command we are waiting for.- Specified by:
setShutdownin interfaceServer- Parameters:
shutdown- The new shutdown command
-
getCatalina
public Catalina getCatalina()
Return the outer Catalina startup/shutdown component if present.- Specified by:
getCatalinain interfaceServer- 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:
setCatalinain interfaceServer- Parameters:
catalina- the outer Catalina component
-
getUtilityThreads
public int getUtilityThreads()
Description copied from interface:ServerGet the utility thread count.- Specified by:
getUtilityThreadsin interfaceServer- Returns:
- the thread count
-
setUtilityThreads
public void setUtilityThreads(int utilityThreads)
Description copied from interface:ServerSet the utility thread count.- Specified by:
setUtilityThreadsin interfaceServer- Parameters:
utilityThreads- the new thread count
-
getUtilityThreadsAsDaemon
public boolean getUtilityThreadsAsDaemon()
Get if the utility threads are daemon threads.- Returns:
- the threads daemon flag
-
setUtilityThreadsAsDaemon
public void setUtilityThreadsAsDaemon(boolean utilityThreadsAsDaemon)
Set the utility threads daemon flag. The default value is true.- Parameters:
utilityThreadsAsDaemon- the new thread daemon flag
-
getPeriodicEventDelay
public int getPeriodicEventDelay()
- Returns:
- The period between two lifecycle events, in seconds
-
setPeriodicEventDelay
public void setPeriodicEventDelay(int periodicEventDelay)
Set the new period between two lifecycle events in seconds.- Parameters:
periodicEventDelay- The period in seconds, negative or zero will disable events
-
addService
public void addService(Service service)
Add a new Service to the set of defined Services.- Specified by:
addServicein interfaceServer- 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.
-
findService
public Service findService(String name)
Description copied from interface:ServerFind the specified Service- Specified by:
findServicein interfaceServer- Parameters:
name- Name of the Service to be returned- Returns:
- the specified Service (if it exists); otherwise return
null.
-
findServices
public Service[] findServices()
- Specified by:
findServicesin interfaceServer- Returns:
- the set of Services defined within this Server.
-
getServiceNames
public ObjectName[] getServiceNames()
- Returns:
- the JMX service names.
-
removeService
public void removeService(Service service)
Remove the specified Service from the set associated from this Server.- Specified by:
removeServicein interfaceServer- Parameters:
service- The Service to be removed
-
getCatalinaBase
public File getCatalinaBase()
- Specified by:
getCatalinaBasein interfaceServer- 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(File catalinaBase)
Description copied from interface:ServerSet the configured base (instance) directory. Note that home and base may be the same (and are by default).- Specified by:
setCatalinaBasein interfaceServer- Parameters:
catalinaBase- the configured base directory
-
getCatalinaHome
public File getCatalinaHome()
- Specified by:
getCatalinaHomein interfaceServer- Returns:
- the configured home (binary) directory. Note that home and base may be the same (and are by default).
-
setCatalinaHome
public void setCatalinaHome(File catalinaHome)
Description copied from interface:ServerSet the configured home (binary) directory. Note that home and base may be the same (and are by default).- Specified by:
setCatalinaHomein interfaceServer- Parameters:
catalinaHome- the configured home directory
-
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.
-
storeConfig
public void storeConfig() throws InstanceNotFoundException, MBeanExceptionWrite the configuration information for this entireServerout to the server.xml configuration file.- Throws:
InstanceNotFoundException- if the managed resource object cannot be foundMBeanException- if the initializer of the object throws an exception, or persistence is not supportedRuntimeOperationsException- if an exception is reported by the persistence mechanism
-
storeContext
public void storeContext(Context context) throws InstanceNotFoundException, MBeanException
Write the configuration information forContextout to the specified configuration file.- Parameters:
context- the context which should save its configuration- Throws:
InstanceNotFoundException- if the managed resource object cannot be foundMBeanException- if the initializer of the object throws an exception or persistence is not supportedRuntimeOperationsException- if an exception is reported by the persistence mechanism
-
startInternal
protected void startInternal() throws LifecycleExceptionStart nested components (Services) and implement the requirements ofLifecycleBase.startInternal().- Specified by:
startInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
startPeriodicLifecycleEvent
protected void startPeriodicLifecycleEvent()
-
stopInternal
protected void stopInternal() throws LifecycleExceptionStop nested components (Services) and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
stopInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that needs to be reported
-
initInternal
protected void initInternal() throws LifecycleExceptionInvoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.- Overrides:
initInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the initialisation fails
-
destroyInternal
protected void destroyInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.- Overrides:
destroyInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the destruction fails
-
getParentClassLoader
public ClassLoader getParentClassLoader()
Return the parent class loader for this component.- Specified by:
getParentClassLoaderin interfaceServer- 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(ClassLoader parent)
Set the parent class loader for this server.- Specified by:
setParentClassLoaderin interfaceServer- Parameters:
parent- The new parent class loader
-
getDomainInternal
protected String getDomainInternal()
Obtain the MBean domain for this server. The domain is obtained using the following search order:- Specified by:
getDomainInternalin classLifecycleMBeanBase- Returns:
- The name of the domain to use to register MBeans.
-
getObjectNameKeyProperties
protected String getObjectNameKeyProperties()
Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the
desired
ObjectName
-
getUtilityExecutor
public ScheduledExecutorService getUtilityExecutor()
- Specified by:
getUtilityExecutorin interfaceServer- Returns:
- the utility executor managed by the Service.
-
-