Tomcat 10.1.19 · org.apache.catalina.core.StandardService

Modifier and Type	Field and Description
protected Connector[]	connectors The set of Connectors associated with this Service.
private final Object	connectorsLock
private Engine	engine
protected final ArrayList<Executor>	executors The list of executors held by the service.
private long	gracefulStopAwaitMillis
private static final Log	log Hides org.apache.catalina.util.LifecycleMBeanBase.log.
protected final Mapper	mapper Mapper.
protected final MapperListener	mapperListener Mapper listener.
private String	name The name of this service.
private ClassLoader	parentClassLoader
private Server	server The `Server` that owns this Service, if any.
private static final StringManager	sm Hides org.apache.catalina.util.LifecycleMBeanBase.sm.
protected final PropertyChangeSupport	support The property change support for this component.

Access	Constructor and Description
public	StandardService()

Method Summary

Modifier and Type	Method and Description
public void	addConnector(Connector The Connector to be added connector) Implements org.apache.catalina.Service.addConnector. Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.
public void	addExecutor(Executor Executor ex) Implements org.apache.catalina.Service.addExecutor. Adds a named executor to the service
public void	addPropertyChangeListener(PropertyChangeListener The listener to add listener) Add a property change listener to this component.
protected void	destroyInternal() Overrides org.apache.catalina.util.LifecycleMBeanBase.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.
public Connector[]	findConnectors() Implements org.apache.catalina.Service.findConnectors. Find and return the set of Connectors associated with this Service.
public Executor[]	Returns: Executor[] findExecutors() Implements org.apache.catalina.Service.findExecutors. Retrieves all executors
public ObjectName[]	getConnectorNames()
public Engine	getContainer() Implements org.apache.catalina.Service.getContainer.
protected String	getDomainInternal() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal. Method implemented by sub-classes to identify the domain in which MBeans should be registered.
public Executor	Returns: Executor getExecutor(String String executorName) Implements org.apache.catalina.Service.getExecutor. Retrieves executor by name, null if not found
public long	getGracefulStopAwaitMillis()
public Mapper	getMapper() Implements org.apache.catalina.Service.getMapper.
public String	getName() Implements org.apache.catalina.Service.getName. Return the name of this Service.
public final String	getObjectNameKeyProperties() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
public ClassLoader	getParentClassLoader() Implements org.apache.catalina.Service.getParentClassLoader. Return the parent class loader for this component.
public Server	getServer() Implements org.apache.catalina.Service.getServer. Return the `Server` with which we are associated (if any).
protected void	initInternal() Overrides org.apache.catalina.util.LifecycleMBeanBase.initInternal. Invoke a pre-startup initialization.
public void	removeConnector(Connector The Connector to be removed connector) Implements org.apache.catalina.Service.removeConnector. Remove the specified Connector from the set associated from this Service.
public void	removeExecutor(Executor Executor ex) Implements org.apache.catalina.Service.removeExecutor. Removes an executor from the service
public void	removePropertyChangeListener(PropertyChangeListener The listener to remove listener) Remove a property change listener from this component.
public void	setContainer(Engine The new Engine engine) Implements org.apache.catalina.Service.setContainer. Set the `Engine` that handles requests for all `Connectors` associated with this Service.
public void	setGracefulStopAwaitMillis(long gracefulStopAwaitMillis)
public void	setName(String The new service name name) Implements org.apache.catalina.Service.setName. Set the name of this Service.
public void	setParentClassLoader(ClassLoader The new parent class loader parent) Implements org.apache.catalina.Service.setParentClassLoader. Set the parent class loader for this server.
public void	setServer(Server The server that owns this Service server) Implements org.apache.catalina.Service.setServer. Set the `Server` with which we are associated (if any).
protected void	startInternal() Implements abstract org.apache.catalina.util.LifecycleBase.startInternal. Start nested components (`Executor`s, `Connector`s and `Container`s) and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`.
protected void	stopInternal() Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal. Stop nested components (`Executor`s, `Connector`s and `Container`s) and implement the requirements of `org.apache.catalina.util.LifecycleBase#stopInternal()`.
public String	toString() Overrides java.lang.Object.toString. Return a String representation of this component.

Inherited from org.apache.catalina.util.LifecycleMBeanBase:: getDomain getObjectName postDeregister postRegister preDeregister preRegister register setDomain unregister unregister

connectors	back to summary
protected Connector[] connectors The set of Connectors associated with this Service.

connectorsLock	back to summary
private final Object connectorsLock

engine	back to summary
private Engine engine

executors	back to summary
protected final ArrayList<Executor> executors The list of executors held by the service.

gracefulStopAwaitMillis	back to summary
private long gracefulStopAwaitMillis

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleMBeanBase.log.

mapper	back to summary
protected final Mapper mapper Mapper.

mapperListener	back to summary
protected final MapperListener mapperListener Mapper listener.

name	back to summary
private String name The name of this service.

parentClassLoader	back to summary
private ClassLoader parentClassLoader

server	back to summary
private Server server The `Server` that owns this Service, if any.

sm	back to summary
private static final StringManager sm Hides org.apache.catalina.util.LifecycleMBeanBase.sm.

support	back to summary
protected final PropertyChangeSupport support The property change support for this component.

StandardService	back to summary
public StandardService()

Method Detail

addConnector	back to summary
public void addConnector(Connector connector) Implements org.apache.catalina.Service.addConnector. Add a new Connector to the set of defined Connectors, and associate it with this Service's Container. Parameters connector:Connector The Connector to be added Annotations @Override

addConnector

back to summary

public void addConnector(Connector connector)

Implements org.apache.catalina.Service.addConnector.

Add a new Connector to the set of defined Connectors, and associate it with this Service's Container.

Parameters

connector:Connector: The Connector to be added

Annotations

@Override

addExecutor	back to summary
public void addExecutor(Executor ex) Implements org.apache.catalina.Service.addExecutor. Adds a named executor to the service Parameters ex:Executor Executor Annotations @Override

addExecutor

back to summary

public void addExecutor(Executor ex)

Implements org.apache.catalina.Service.addExecutor.

Adds a named executor to the service

Parameters

ex:Executor: Executor

Annotations

@Override

addPropertyChangeListener	back to summary
public void addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener to this component. Parameters listener:PropertyChangeListener The listener to add

addPropertyChangeListener

back to summary

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener to this component.

Parameters

listener:PropertyChangeListener: The listener to add

destroyInternal	back to summary
protected void destroyInternal() throws LifecycleException Overrides org.apache.catalina.util.LifecycleMBeanBase.destroyInternal. Doc from org.apache.catalina.util.LifecycleMBeanBase.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. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.destroyInternal. If the destruction fails

destroyInternal

back to summary

protected void destroyInternal() throws LifecycleException

Overrides org.apache.catalina.util.LifecycleMBeanBase.destroyInternal.

Doc from org.apache.catalina.util.LifecycleMBeanBase.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.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.destroyInternal.

If the destruction fails

findConnectors	back to summary
public Connector[] findConnectors() Implements org.apache.catalina.Service.findConnectors. Find and return the set of Connectors associated with this Service. Returns:Connector[] Doc from org.apache.catalina.Service.findConnectors. the set of associated Connectors Annotations @Override

findConnectors

back to summary

public Connector[] findConnectors()

Implements org.apache.catalina.Service.findConnectors.

Find and return the set of Connectors associated with this Service.

Returns:Connector[]

Doc from org.apache.catalina.Service.findConnectors.

the set of associated Connectors

Annotations

@Override

findExecutors	back to summary
public Executor[] findExecutors() Implements org.apache.catalina.Service.findExecutors. Retrieves all executors Returns:Executor[] Executor[] Annotations @Override

findExecutors

back to summary

public Executor[] findExecutors()

Implements org.apache.catalina.Service.findExecutors.

Retrieves all executors

Returns:Executor[]

Executor[]

Annotations

@Override

getConnectorNames	back to summary
public ObjectName[] getConnectorNames()

getContainer back to summary

getContainer	back to summary
public Engine getContainer() Implements org.apache.catalina.Service.getContainer. Returns:Engine Doc from org.apache.catalina.Service.getContainer. the `Engine` that handles requests for all `Connectors` associated with this Service. Annotations @Override

public Engine getContainer()

Implements org.apache.catalina.Service.getContainer.

Returns:Engine

Doc from org.apache.catalina.Service.getContainer.

the Engine that handles requests for all Connectors associated with this Service.

Annotations

@Override

getDomainInternal	back to summary
protected String getDomainInternal() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal. Doc from org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal. Method implemented by sub-classes to identify the domain in which MBeans should be registered. Returns:String The name of the domain to use to register MBeans. Annotations @Override

getDomainInternal

back to summary

protected String getDomainInternal()

Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal.

Doc from org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal.

Method implemented by sub-classes to identify the domain in which MBeans should be registered.

Returns:String

The name of the domain to use to register MBeans.

Annotations

@Override

getExecutor	back to summary
public Executor getExecutor(String executorName) Implements org.apache.catalina.Service.getExecutor. Retrieves executor by name, null if not found Parameters executorName:String String Returns:Executor Executor Annotations @Override

getExecutor

back to summary

public Executor getExecutor(String executorName)

Implements org.apache.catalina.Service.getExecutor.

Retrieves executor by name, null if not found

Parameters

executorName:String: String

Returns:Executor

Executor

Annotations

@Override

getGracefulStopAwaitMillis	back to summary
public long getGracefulStopAwaitMillis()

getMapper	back to summary
public Mapper getMapper() Implements org.apache.catalina.Service.getMapper. Returns:Mapper Doc from org.apache.catalina.Service.getMapper. the mapper associated with this Service. Annotations @Override

getMapper

back to summary

public Mapper getMapper()

Implements org.apache.catalina.Service.getMapper.

Returns:Mapper

Doc from org.apache.catalina.Service.getMapper.

the mapper associated with this Service.

Annotations

@Override

getName	back to summary
public String getName() Implements org.apache.catalina.Service.getName. Return the name of this Service. Returns:String Doc from org.apache.catalina.Service.getName. the name of this Service. Annotations @Override

getName

back to summary

public String getName()

Implements org.apache.catalina.Service.getName.

Return the name of this Service.

Returns:String

Doc from org.apache.catalina.Service.getName.

the name of this Service.

Annotations

@Override

getObjectNameKeyProperties back to summary

getObjectNameKeyProperties	back to summary
public final String getObjectNameKeyProperties() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Doc from org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component. Returns:String The string representation of the key properties component of the desired `ObjectName` Annotations @Override

public final String getObjectNameKeyProperties()

Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties.

Doc from org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties.

Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.

Returns:String

The string representation of the key properties component of the desired ObjectName

Annotations

@Override

getParentClassLoader back to summary

getParentClassLoader	back to summary
public ClassLoader getParentClassLoader() Implements org.apache.catalina.Service.getParentClassLoader. Return the parent class loader for this component. Returns:ClassLoader Doc from org.apache.catalina.Service.getParentClassLoader. the parent class loader for this component. If not set, return `getServer()` `Server#getParentClassLoader()`. If no server has been set, return the system class loader. Annotations @Override

public ClassLoader getParentClassLoader()

Implements org.apache.catalina.Service.getParentClassLoader.

Return the parent class loader for this component.

Returns:ClassLoader

Doc from org.apache.catalina.Service.getParentClassLoader.

the parent class loader for this component. If not set, return getServer() Server#getParentClassLoader(). If no server has been set, return the system class loader.

Annotations

@Override

getServer back to summary

getServer	back to summary
public Server getServer() Implements org.apache.catalina.Service.getServer. Return the `Server` with which we are associated (if any). Returns:Server Doc from org.apache.catalina.Service.getServer. the `Server` with which we are associated (if any). Annotations @Override

public Server getServer()

Implements org.apache.catalina.Service.getServer.

Return the Server with which we are associated (if any).

Returns:Server

Doc from org.apache.catalina.Service.getServer.

the Server with which we are associated (if any).

Annotations

@Override

initInternal	back to summary
protected void initInternal() throws LifecycleException Overrides org.apache.catalina.util.LifecycleMBeanBase.initInternal. Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.initInternal. If the initialisation fails

initInternal

back to summary

protected void initInternal() throws LifecycleException

Overrides org.apache.catalina.util.LifecycleMBeanBase.initInternal.

Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.initInternal.

If the initialisation fails

removeConnector	back to summary
public void removeConnector(Connector connector) Implements org.apache.catalina.Service.removeConnector. Remove the specified Connector from the set associated from this Service. The removed Connector will also be disassociated from our Container. Parameters connector:Connector The Connector to be removed Annotations @Override

removeConnector

back to summary

public void removeConnector(Connector connector)

Implements org.apache.catalina.Service.removeConnector.

Remove the specified Connector from the set associated from this Service. The removed Connector will also be disassociated from our Container.

Parameters

connector:Connector: The Connector to be removed

Annotations

@Override

removeExecutor	back to summary
public void removeExecutor(Executor ex) Implements org.apache.catalina.Service.removeExecutor. Removes an executor from the service Parameters ex:Executor Executor Annotations @Override

removeExecutor

back to summary

public void removeExecutor(Executor ex)

Implements org.apache.catalina.Service.removeExecutor.

Removes an executor from the service

Parameters

ex:Executor: Executor

Annotations

@Override

removePropertyChangeListener	back to summary
public void removePropertyChangeListener(PropertyChangeListener listener) Remove a property change listener from this component. Parameters listener:PropertyChangeListener The listener to remove

removePropertyChangeListener

back to summary

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a property change listener from this component.

Parameters

listener:PropertyChangeListener: The listener to remove

setContainer back to summary

setContainer	back to summary
public void setContainer(Engine engine) Implements org.apache.catalina.Service.setContainer. Doc from org.apache.catalina.Service.setContainer. Set the `Engine` that handles requests for all `Connectors` associated with this Service. Parameters engine:Engine The new Engine Annotations @Override

public void setContainer(Engine engine)

Implements org.apache.catalina.Service.setContainer.

Doc from org.apache.catalina.Service.setContainer.

Set the Engine that handles requests for all Connectors associated with this Service.

Parameters

engine:Engine: The new Engine

Annotations

@Override

setGracefulStopAwaitMillis	back to summary
public void setGracefulStopAwaitMillis(long gracefulStopAwaitMillis)

setName	back to summary
public void setName(String name) Implements org.apache.catalina.Service.setName. Set the name of this Service. Parameters name:String The new service name Annotations @Override

setName

back to summary

public void setName(String name)

Implements org.apache.catalina.Service.setName.

Set the name of this Service.

Parameters

name:String: The new service name

Annotations

@Override

setParentClassLoader	back to summary
public void setParentClassLoader(ClassLoader parent) Implements org.apache.catalina.Service.setParentClassLoader. Set the parent class loader for this server. Parameters parent:ClassLoader The new parent class loader Annotations @Override

setParentClassLoader

back to summary

public void setParentClassLoader(ClassLoader parent)

Implements org.apache.catalina.Service.setParentClassLoader.

Set the parent class loader for this server.

Parameters

parent:ClassLoader: The new parent class loader

Annotations

@Override

setServer back to summary

setServer	back to summary
public void setServer(Server server) Implements org.apache.catalina.Service.setServer. Set the `Server` with which we are associated (if any). Parameters server:Server The server that owns this Service Annotations @Override

public void setServer(Server server)

Implements org.apache.catalina.Service.setServer.

Set the Server with which we are associated (if any).

Parameters

server:Server: The server that owns this Service

Annotations

@Override

startInternal back to summary

startInternal	back to summary
protected void startInternal() throws LifecycleException Implements abstract org.apache.catalina.util.LifecycleBase.startInternal. Start nested components (`Executor`s, `Connector`s and `Container`s) and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`. Annotations @Override Exceptions LifecycleException: if this component detects a fatal error that prevents this component from being used

protected void startInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.startInternal.

Start nested components (Executors, Connectors and Containers) and implement the requirements of org.apache.catalina.util.LifecycleBase#startInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that prevents this component from being used

stopInternal back to summary

stopInternal	back to summary
protected void stopInternal() throws LifecycleException Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal. Stop nested components (`Executor`s, `Connector`s and `Container`s) and implement the requirements of `org.apache.catalina.util.LifecycleBase#stopInternal()`. Annotations @Override Exceptions LifecycleException: if this component detects a fatal error that needs to be reported

protected void stopInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal.

Stop nested components (Executors, Connectors and Containers) and implement the requirements of org.apache.catalina.util.LifecycleBase#stopInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that needs to be reported

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a String representation of this component. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this component.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class StandardService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail