AbstractProtocol (Apache Tomcat 9.0.0.M9 API Documentation)

java.lang.Object
- org.apache.coyote.AbstractProtocol<S>

All Implemented Interfaces:

MBeanRegistration, ProtocolHandler

Direct Known Subclasses:

AbstractAjpProtocol, AbstractHttp11Protocol
```
public abstract class AbstractProtocol<S>
extends Object
implements ProtocolHandler, MBeanRegistration
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractProtocol.AsyncTimeout` Async timeout thread
`protected static class`	`AbstractProtocol.ConnectionHandler<S>`
`protected static class`	`AbstractProtocol.RecycledProcessors`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Adapter`	`adapter` The adapter provides the link between the ProtocolHandler and the connector.
`protected String`	`clientCertProvider` When client certificate information is presented in a form other than instances of `X509Certificate` it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion.
`protected String`	`domain`
`protected MBeanServer`	`mserver`
`protected ObjectName`	`oname`
`protected int`	`processorCache` The maximum number of idle processors that will be retained in the cache and re-used with a subsequent request.
`protected ObjectName`	`rgOname` Name of MBean for the Global Request Processor.
`protected ObjectName`	`tpOname` Name of MBean for the ThreadPool.

Constructor Summary

Constructors
Constructor and Description

AbstractProtocol(AbstractEndpoint<S> endpoint)

Constructors
Constructor and Description
`AbstractProtocol(AbstractEndpoint<S> endpoint)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWaitingProcessor(Processor processor)`
`protected abstract Processor`	`createProcessor()` Create and configure a new Processor instance for the current protocol implementation.
`protected abstract Processor`	`createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken)`
`void`	`destroy()` Destroy the protocol (optional).
`int`	`getAcceptorThreadCount()`
`int`	`getAcceptorThreadPriority()`
`Adapter`	`getAdapter()`
`InetAddress`	`getAddress()`
`AbstractProtocol.AsyncTimeout`	`getAsyncTimeout()`
`int`	`getBacklog()`
`String`	`getClientCertProvider()`
`long`	`getConnectionCount()`
`int`	`getConnectionTimeout()`
`String`	`getDomain()`
`protected AbstractEndpoint<S>`	`getEndpoint()`
`Executor`	`getExecutor()` The executor, provide access to the underlying thread pool.
`protected AbstractEndpoint.Handler<S>`	`getHandler()`
`int`	`getKeepAliveTimeout()`
`int`	`getLocalPort()`
`protected abstract Log`	`getLog()` Concrete implementations need to provide access to their logger to be used by the abstract classes.
`int`	`getMaxConnections()`
`int`	`getMaxHeaderCount()`
`int`	`getMaxThreads()`
`int`	`getMinSpareThreads()`
`String`	`getName()` The name will be prefix-address-port if address is non-null and prefix-port if the address is null.
`int`	`getNameIndex()`
`protected abstract String`	`getNamePrefix()` Obtain the prefix to be used when construction a name for this protocol handler.
`protected abstract UpgradeProtocol`	`getNegotiatedProtocol(String name)` Find a suitable handler for the protocol negotiated at the network layer.
`ObjectName`	`getObjectName()`
`int`	`getPort()`
`int`	`getProcessorCache()`
`String`	`getProperty(String name)` Generic property getter used by the digester.
`protected abstract String`	`getProtocolName()` Obtain the name of the protocol, (Http, Ajp, etc.).
`int`	`getSoLinger()`
`int`	`getSoTimeout()`
`boolean`	`getTcpNoDelay()`
`int`	`getThreadPriority()`
`protected abstract UpgradeProtocol`	`getUpgradeProtocol(String name)` Find a suitable handler for the protocol upgraded name specified.
`void`	`init()` Initialise the protocol.
`boolean`	`isAprRequired()` Requires APR/native library
`boolean`	`isSendfileSupported()` Does this ProtocolHandler support sendfile?
`void`	`pause()` Pause the protocol (optional).
`void`	`postDeregister()`
`void`	`postRegister(Boolean registrationDone)`
`void`	`preDeregister()`
`ObjectName`	`preRegister(MBeanServer server, ObjectName name)`
`void`	`removeWaitingProcessor(Processor processor)`
`void`	`resume()` Resume the protocol (optional).
`void`	`setAcceptorThreadCount(int threadCount)`
`void`	`setAcceptorThreadPriority(int threadPriority)`
`void`	`setAdapter(Adapter adapter)` The adapter, used to call the connector.
`void`	`setAddress(InetAddress ia)`
`void`	`setBacklog(int backlog)`
`void`	`setClientCertProvider(String s)`
`void`	`setConnectionTimeout(int timeout)`
`void`	`setExecutor(Executor executor)`
`protected void`	`setHandler(AbstractEndpoint.Handler<S> handler)`
`void`	`setKeepAliveTimeout(int keepAliveTimeout)`
`void`	`setMaxConnections(int maxConnections)`
`void`	`setMaxHeaderCount(int maxHeaderCount)`
`void`	`setMaxThreads(int maxThreads)`
`void`	`setMinSpareThreads(int minSpareThreads)`
`void`	`setPort(int port)`
`void`	`setProcessorCache(int processorCache)`
`boolean`	`setProperty(String name, String value)` Generic property setter used by the digester.
`void`	`setSoLinger(int soLinger)`
`void`	`setSoTimeout(int timeout)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setThreadPriority(int threadPriority)`
`void`	`start()` Start the protocol.
`void`	`stop()` Stop the protocol.

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

Methods inherited from interface org.apache.coyote.ProtocolHandler
addSslHostConfig, addUpgradeProtocol, findSslHostConfigs, findUpgradeProtocols

- Field Detail
  - rgOname
```
protected ObjectName rgOname
```
    Name of MBean for the Global Request Processor.
  - tpOname
```
protected ObjectName tpOname
```
    Name of MBean for the ThreadPool.
  - adapter
```
protected Adapter adapter
```
    The adapter provides the link between the ProtocolHandler and the connector.
  - processorCache
```
protected int processorCache
```
    The maximum number of idle processors that will be retained in the cache and re-used with a subsequent request. The default is 200. A value of -1 means unlimited. In the unlimited case, the theoretical maximum number of cached Processor objects is getMaxConnections() although it will usually be closer to getMaxThreads().
  - clientCertProvider
```
protected String clientCertProvider
```
    When client certificate information is presented in a form other than instances of X509Certificate it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion. For example it is used with the AJP connectors, the HTTP APR connector and with the SSLValve. If not specified, the default provider will be used.
  - domain
```
protected String domain
```
  - oname
```
protected ObjectName oname
```
  - mserver
```
protected MBeanServer mserver
```
- Constructor Detail
  - AbstractProtocol
```
public AbstractProtocol(AbstractEndpoint<S> endpoint)
```
- Method Detail
  - setProperty
```
public boolean setProperty(String name,
                           String value)
```
    Generic property setter used by the digester. Other code should not need to use this. The digester will only use this method if it can't find a more specific setter. That means the property belongs to the Endpoint, the ServerSocketFactory or some other lower level component. This method ensures that it is visible to both.
    
    Parameters:
    
    name - The name of the property to set
    
    value - The value, in string form, to set for the property
    
    Returns:
    
    true if the property was set successfully, otherwise false
  - getProperty
```
public String getProperty(String name)
```
    Generic property getter used by the digester. Other code should not need to use this.
    
    Parameters:
    
    name - The name of the property to get
    
    Returns:
    
    The value of the property converted to a string
  - setAdapter
```
public void setAdapter(Adapter adapter)
```
    Description copied from interface: ProtocolHandler
    
    The adapter, used to call the connector.
    
    Specified by:
    
    setAdapter in interface ProtocolHandler
    
    Parameters:
    
    adapter - The adapter to associate
  - getAdapter
```
public Adapter getAdapter()
```
    Specified by:
    
    getAdapter in interface ProtocolHandler
  - getProcessorCache
```
public int getProcessorCache()
```
  - setProcessorCache
```
public void setProcessorCache(int processorCache)
```
  - getClientCertProvider
```
public String getClientCertProvider()
```
  - setClientCertProvider
```
public void setClientCertProvider(String s)
```
  - isAprRequired
```
public boolean isAprRequired()
```
    Description copied from interface: ProtocolHandler
    
    Requires APR/native library
    
    Specified by:
    
    isAprRequired in interface ProtocolHandler
    
    Returns:
    
    true if this Protocol Handler requires the APR/native library, otherwise false
  - isSendfileSupported
```
public boolean isSendfileSupported()
```
    Description copied from interface: ProtocolHandler
    
    Does this ProtocolHandler support sendfile?
    
    Specified by:
    
    isSendfileSupported in interface ProtocolHandler
    
    Returns:
    
    true if this Protocol Handler supports sendfile, otherwise false
  - getAsyncTimeout
```
public AbstractProtocol.AsyncTimeout getAsyncTimeout()
```
  - getExecutor
```
public Executor getExecutor()
```
    Description copied from interface: ProtocolHandler
    
    The executor, provide access to the underlying thread pool.
    
    Specified by:
    
    getExecutor in interface ProtocolHandler
    
    Returns:
    
    The executor used to process requests
  - setExecutor
```
public void setExecutor(Executor executor)
```
  - getMaxThreads
```
public int getMaxThreads()
```
  - setMaxThreads
```
public void setMaxThreads(int maxThreads)
```
  - getMaxConnections
```
public int getMaxConnections()
```
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
  - getMinSpareThreads
```
public int getMinSpareThreads()
```
  - setMinSpareThreads
```
public void setMinSpareThreads(int minSpareThreads)
```
  - getThreadPriority
```
public int getThreadPriority()
```
  - setThreadPriority
```
public void setThreadPriority(int threadPriority)
```
  - getBacklog
```
public int getBacklog()
```
  - setBacklog
```
public void setBacklog(int backlog)
```
  - getTcpNoDelay
```
public boolean getTcpNoDelay()
```
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean tcpNoDelay)
```
  - getSoLinger
```
public int getSoLinger()
```
  - setSoLinger
```
public void setSoLinger(int soLinger)
```
  - getKeepAliveTimeout
```
public int getKeepAliveTimeout()
```
  - setKeepAliveTimeout
```
public void setKeepAliveTimeout(int keepAliveTimeout)
```
  - getAddress
```
public InetAddress getAddress()
```
  - setAddress
```
public void setAddress(InetAddress ia)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
  - getLocalPort
```
public int getLocalPort()
```
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
  - setConnectionTimeout
```
public void setConnectionTimeout(int timeout)
```
  - getSoTimeout
```
public int getSoTimeout()
```
  - setSoTimeout
```
public void setSoTimeout(int timeout)
```
  - getMaxHeaderCount
```
public int getMaxHeaderCount()
```
  - setMaxHeaderCount
```
public void setMaxHeaderCount(int maxHeaderCount)
```
  - getConnectionCount
```
public long getConnectionCount()
```
  - setAcceptorThreadCount
```
public void setAcceptorThreadCount(int threadCount)
```
  - getAcceptorThreadCount
```
public int getAcceptorThreadCount()
```
  - setAcceptorThreadPriority
```
public void setAcceptorThreadPriority(int threadPriority)
```
  - getAcceptorThreadPriority
```
public int getAcceptorThreadPriority()
```
  - getNameIndex
```
public int getNameIndex()
```
  - getName
```
public String getName()
```
    The name will be prefix-address-port if address is non-null and prefix-port if the address is null.
    
    Returns:
    
    A name for this protocol instance that is appropriately quoted for use in an ObjectName.
  - addWaitingProcessor
```
public void addWaitingProcessor(Processor processor)
```
  - removeWaitingProcessor
```
public void removeWaitingProcessor(Processor processor)
```
  - getEndpoint
```
protected AbstractEndpoint<S> getEndpoint()
```
  - getHandler
```
protected AbstractEndpoint.Handler<S> getHandler()
```
  - setHandler
```
protected void setHandler(AbstractEndpoint.Handler<S> handler)
```
  - getLog
```
protected abstract Log getLog()
```
    Concrete implementations need to provide access to their logger to be used by the abstract classes.
    
    Returns:
    
    the logger
  - getNamePrefix
```
protected abstract String getNamePrefix()
```
    Obtain the prefix to be used when construction a name for this protocol handler. The name will be prefix-address-port.
    
    Returns:
    
    the prefix
  - getProtocolName
```
protected abstract String getProtocolName()
```
    Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX.
    
    Returns:
    
    the protocol name
  - getNegotiatedProtocol
```
protected abstract UpgradeProtocol getNegotiatedProtocol(String name)
```
    Find a suitable handler for the protocol negotiated at the network layer.
    
    Parameters:
    
    name - The name of the requested negotiated protocol.
    
    Returns:
    
    The instance where UpgradeProtocol.getAlpnName() matches the requested protocol
  - getUpgradeProtocol
```
protected abstract UpgradeProtocol getUpgradeProtocol(String name)
```
    Find a suitable handler for the protocol upgraded name specified. This is used for direct connection protocol selection.
    
    Parameters:
    
    name - The name of the requested negotiated protocol.
    
    Returns:
    
    The instance where UpgradeProtocol.getAlpnName() matches the requested protocol
  - createProcessor
```
protected abstract Processor createProcessor()
```
    Create and configure a new Processor instance for the current protocol implementation.
    
    Returns:
    
    A fully configured Processor instance that is ready to use
  - createUpgradeProcessor
```
protected abstract Processor createUpgradeProcessor(SocketWrapperBase<?> socket,
                                                    UpgradeToken upgradeToken)
```
  - getObjectName
```
public ObjectName getObjectName()
```
  - getDomain
```
public String getDomain()
```
  - preRegister
```
public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception
```
    Specified by:
    
    preRegister in interface MBeanRegistration
    
    Throws:
    
    Exception
  - postRegister
```
public void postRegister(Boolean registrationDone)
```
    Specified by:
    
    postRegister in interface MBeanRegistration
  - preDeregister
```
public void preDeregister()
                   throws Exception
```
    Specified by:
    
    preDeregister in interface MBeanRegistration
    
    Throws:
    
    Exception
  - postDeregister
```
public void postDeregister()
```
    Specified by:
    
    postDeregister in interface MBeanRegistration
  - init
```
public void init()
          throws Exception
```
    Description copied from interface: ProtocolHandler
    
    Initialise the protocol.
    
    Specified by:
    
    init in interface ProtocolHandler
    
    Throws:
    
    Exception - If the protocol handler fails to initialise
  - start
```
public void start()
           throws Exception
```
    Description copied from interface: ProtocolHandler
    
    Start the protocol.
    
    Specified by:
    
    start in interface ProtocolHandler
    
    Throws:
    
    Exception - If the protocol handler fails to start
  - pause
```
public void pause()
           throws Exception
```
    Description copied from interface: ProtocolHandler
    
    Pause the protocol (optional).
    
    Specified by:
    
    pause in interface ProtocolHandler
    
    Throws:
    
    Exception - If the protocol handler fails to pause
  - resume
```
public void resume()
            throws Exception
```
    Description copied from interface: ProtocolHandler
    
    Resume the protocol (optional).
    
    Specified by:
    
    resume in interface ProtocolHandler
    
    Throws:
    
    Exception - If the protocol handler fails to resume
  - stop
```
public void stop()
          throws Exception
```
    Description copied from interface: ProtocolHandler
    
    Stop the protocol.
    
    Specified by:
    
    stop in interface ProtocolHandler
    
    Throws:
    
    Exception - If the protocol handler fails to stop
  - destroy
```
public void destroy()
```
    Description copied from interface: ProtocolHandler
    
    Destroy the protocol (optional).
    
    Specified by:
    
    destroy in interface ProtocolHandler

Class AbstractProtocol<S>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.coyote.ProtocolHandler

Field Detail

rgOname

tpOname

adapter

processorCache

clientCertProvider

domain

oname

mserver

Constructor Detail

AbstractProtocol

Method Detail

setProperty

getProperty

setAdapter

getAdapter

getProcessorCache

setProcessorCache

getClientCertProvider

setClientCertProvider

isAprRequired

isSendfileSupported

getAsyncTimeout

getExecutor

setExecutor

getMaxThreads

setMaxThreads

getMaxConnections

setMaxConnections

getMinSpareThreads

setMinSpareThreads

getThreadPriority

setThreadPriority

getBacklog

setBacklog

getTcpNoDelay

setTcpNoDelay

getSoLinger

setSoLinger

getKeepAliveTimeout

setKeepAliveTimeout

getAddress

setAddress

getPort

setPort

getLocalPort

getConnectionTimeout

setConnectionTimeout

getSoTimeout

setSoTimeout

getMaxHeaderCount

setMaxHeaderCount

getConnectionCount

setAcceptorThreadCount

getAcceptorThreadCount

setAcceptorThreadPriority

getAcceptorThreadPriority

getNameIndex

getName

addWaitingProcessor

removeWaitingProcessor

getEndpoint

getHandler

setHandler

getLog

getNamePrefix

getProtocolName

getNegotiatedProtocol

getUpgradeProtocol

createProcessor

createUpgradeProcessor

getObjectName

getDomain