Package org.apache.catalina.core
Class StandardService
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.core.StandardService
- All Implemented Interfaces:
- MBeanRegistration,- JmxEnabled,- Lifecycle,- Service
Standard implementation of the 
Service interface. The associated Container is generally an instance of
 Engine, but this is not required.- Author:
- Craig R. McClanahan
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected Connector[]The set of Connectors associated with this Service.The list of executors held by the service.protected final MapperMapper.protected final MapperListenerMapper listener.protected final PropertyChangeSupportThe property change support for this component.Fields inherited from interface org.apache.catalina.LifecycleAFTER_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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddConnector(Connector connector) Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.voidaddExecutor(Executor ex) Adds a named executor to the servicevoidAdd a property change listener to this component.protected voidSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.Find and return the set of Connectors associated with this Service.Executor[]Retrieves all executorsprotected StringMethod implemented by sub-classes to identify the domain in which MBeans should be registered.getExecutor(String executorName) Retrieves executor by name, null if not foundlonggetName()Return the name of this Service.final StringAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.Return the parent class loader for this component.Return theServerwith which we are associated (if any).protected voidInvoke a pre-startup initialization.voidremoveConnector(Connector connector) Remove the specified Connector from the set associated from this Service.voidRemoves an executor from the servicevoidRemove a property change listener from this component.voidsetContainer(Engine engine) Set theEnginethat handles requests for allConnectorsassociated with this Service.voidsetGracefulStopAwaitMillis(long gracefulStopAwaitMillis) voidSet the name of this Service.voidsetParentClassLoader(ClassLoader parent) Set the parent class loader for this server.voidSet theServerwith which we are associated (if any).protected voidStart nested components (Executors,Connectors andContainers) and implement the requirements ofLifecycleBase.startInternal().protected voidStop nested components (Executors,Connectors andContainers) and implement the requirements ofLifecycleBase.stopInternal().toString()Return a String representation of this component.Methods inherited from class org.apache.catalina.util.LifecycleMBeanBasegetDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
- 
Field Details- 
supportThe property change support for this component.
- 
connectorsThe set of Connectors associated with this Service.
- 
executorsThe list of executors held by the service.
- 
mapperMapper.
- 
mapperListenerMapper listener.
 
- 
- 
Constructor Details- 
StandardServicepublic StandardService()
 
- 
- 
Method Details- 
getGracefulStopAwaitMillispublic long getGracefulStopAwaitMillis()
- 
setGracefulStopAwaitMillispublic void setGracefulStopAwaitMillis(long gracefulStopAwaitMillis) 
- 
getMapper
- 
getContainer- Specified by:
- getContainerin interface- Service
- Returns:
- the Enginethat handles requests for allConnectorsassociated with this Service.
 
- 
setContainerDescription copied from interface:ServiceSet theEnginethat handles requests for allConnectorsassociated with this Service.- Specified by:
- setContainerin interface- Service
- Parameters:
- engine- The new Engine
 
- 
getNameReturn the name of this Service.
- 
setNameSet the name of this Service.
- 
getServerReturn theServerwith which we are associated (if any).
- 
setServerSet theServerwith which we are associated (if any).
- 
addConnectorAdd a new Connector to the set of defined Connectors, and associate it with this Service's Container.- Specified by:
- addConnectorin interface- Service
- Parameters:
- connector- The Connector to be added
 
- 
getConnectorNames
- 
addPropertyChangeListenerAdd a property change listener to this component.- Parameters:
- listener- The listener to add
 
- 
findConnectorsFind and return the set of Connectors associated with this Service.- Specified by:
- findConnectorsin interface- Service
- Returns:
- the set of associated Connectors
 
- 
removeConnectorRemove the specified Connector from the set associated from this Service. The removed Connector will also be disassociated from our Container.- Specified by:
- removeConnectorin interface- Service
- Parameters:
- connector- The Connector to be removed
 
- 
removePropertyChangeListenerRemove a property change listener from this component.- Parameters:
- listener- The listener to remove
 
- 
toStringReturn a String representation of this component.
- 
addExecutorAdds a named executor to the service- Specified by:
- addExecutorin interface- Service
- Parameters:
- ex- Executor
 
- 
findExecutorsRetrieves all executors- Specified by:
- findExecutorsin interface- Service
- Returns:
- Executor[]
 
- 
getExecutorRetrieves executor by name, null if not found- Specified by:
- getExecutorin interface- Service
- Parameters:
- executorName- String
- Returns:
- Executor
 
- 
removeExecutorRemoves an executor from the service- Specified by:
- removeExecutorin interface- Service
- Parameters:
- ex- Executor
 
- 
startInternalStart nested components (Executors,Connectors andContainers) and implement the requirements ofLifecycleBase.startInternal().- Specified by:
- startInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
stopInternalStop nested components (Executors,Connectors andContainers) and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
- stopInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that needs to be reported
 
- 
initInternalInvoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.- Overrides:
- initInternalin class- LifecycleMBeanBase
- Throws:
- LifecycleException- If the initialisation fails
 
- 
destroyInternalDescription 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 class- LifecycleMBeanBase
- Throws:
- LifecycleException- If the destruction fails
 
- 
getParentClassLoaderReturn the parent class loader for this component.- Specified by:
- getParentClassLoaderin interface- Service
- Returns:
- the parent class loader for this component. If not set, return
 Service.getServer()Server.getParentClassLoader(). If no server has been set, return the system class loader.
 
- 
setParentClassLoaderSet the parent class loader for this server.- Specified by:
- setParentClassLoaderin interface- Service
- Parameters:
- parent- The new parent class loader
 
- 
getDomainInternalDescription copied from class:LifecycleMBeanBaseMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Specified by:
- getDomainInternalin class- LifecycleMBeanBase
- Returns:
- The name of the domain to use to register MBeans.
 
- 
getObjectNameKeyPropertiesDescription copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
- getObjectNameKeyPropertiesin class- LifecycleMBeanBase
- Returns:
- The string representation of the key properties component of the
          desired ObjectName
 
 
-