Tomcat 10.1.19 · org.apache.coyote.AbstractProtocol · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
protected static class	AbstractProtocol.ConnectionHandler<S>
protected static class	AbstractProtocol.RecycledProcessors

Modifier and Type	Field and Description
protected Adapter	adapter The adapter provides the link between the ProtocolHandler and the connector.
private String	clientCertProvider
protected String	domain
private final AbstractEndpoint<S, ?>	endpoint Endpoint that provides low-level network I/O - must be matched to the ProtocolHandler implementation (ProtocolHandler using NIO, requires NIO Endpoint etc.).
private AbstractEndpoint.Handler<S>	handler
private int	maxHeaderCount
private ScheduledFuture<?>	monitorFuture
protected MBeanServer	mserver
private static final AtomicInteger	nameCounter Counter used to generate unique JMX names for connectors using automatic port binding.
private int	nameIndex Unique ID for this connector.
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.
private static final StringManager	sm The string manager for this package.
private ScheduledFuture<?>	timeoutFuture Controller for the timeout scheduling.
private final Set<Processor>	waitingProcessors

Access	Constructor and Description
public	AbstractProtocol(AbstractEndpoint<S, ?> endpoint)

Method Summary

Modifier and Type	Method and Description
public void	addWaitingProcessor(Processor processor)
public long	awaitConnectionsClose(long The maximum time to wait in milliseconds for the client connections to close. waitMillis) Implements org.apache.coyote.ProtocolHandler.awaitConnectionsClose. Wait for the client connections to the server to close gracefully.
public void	closeServerSocketGraceful() Implements org.apache.coyote.ProtocolHandler.closeServerSocketGraceful. Close the server socket (to prevent further connections) if the server socket was bound on `start()` (rather than on `init()` but do not perform any further shutdown.
private ObjectName	createObjectName()
protected abstract Processor	Returns: A fully configured Processor instance that is ready to use createProcessor() Create and configure a new Processor instance for the current protocol implementation.
protected abstract Processor	createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken)
public void	destroy() Implements org.apache.coyote.ProtocolHandler.destroy. Destroy the protocol (optional).
public int	getAcceptCount()
public int	getAcceptorThreadPriority()
public Adapter	getAdapter() Implements org.apache.coyote.ProtocolHandler.getAdapter. Return the adapter associated with the protocol handler.
public InetAddress	getAddress()
public String	Returns: The name of the JSSE provider to use getClientCertProvider() When client certificate information is presented in a form other than instances of `java.security.cert.X509Certificate` it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion.
public long	getConnectionCount()
public int	getConnectionLinger()
public int	getConnectionTimeout()
public String	getDomain()
protected AbstractEndpoint<S, ?>	getEndpoint()
public Executor	getExecutor() Implements org.apache.coyote.ProtocolHandler.getExecutor. The executor, provide access to the underlying thread pool.
public ObjectName	getGlobalRequestProcessorMBeanName()
protected AbstractEndpoint.Handler<S>	getHandler()
public String	getId() Overrides default org.apache.coyote.ProtocolHandler.getId. The default behavior is to identify connectors uniquely with address and port.
public int	Returns: The timeout in milliseconds getKeepAliveTimeout() The time Tomcat will wait for a subsequent request before closing the connection.
public int	getLocalPort()
protected abstract Log	Returns: the logger getLog() Concrete implementations need to provide access to their logger to be used by the abstract classes.
public int	getMaxConnections()
public int	getMaxHeaderCount()
public int	getMaxThreads()
public int	getMinSpareThreads()
public String	Returns: A name for this protocol instance that is appropriately quoted for use in an ObjectName. getName() The name will be prefix-address-port if address is non-null and prefix-port if the address is null.
public synchronized int	getNameIndex()
private String	getNameInternal()
protected abstract String	Returns: the prefix getNamePrefix() Obtain the prefix to be used when construction a name for this protocol handler.
protected abstract UpgradeProtocol	Returns: The instance where `UpgradeProtocol#getAlpnName()` matches the requested protocol getNegotiatedProtocol(String The name of the requested negotiated protocol. name) Find a suitable handler for the protocol negotiated at the network layer.
public ObjectName	getObjectName()
public int	getPort()
public int	getPortOffset()
public int	getPortWithOffset()
public int	getProcessorCache()
public String	Returns: The value of the property converted to a string getProperty(String The name of the property to get name) Generic property getter used by the digester.
protected abstract String	Returns: the protocol name getProtocolName() Obtain the name of the protocol, (Http, Ajp, etc.).
public boolean	getTcpNoDelay()
public int	getThreadPriority()
protected abstract UpgradeProtocol	Returns: The instance where `UpgradeProtocol#getAlpnName()` matches the requested protocol getUpgradeProtocol(String The name of the requested negotiated protocol. name) Find a suitable handler for the protocol upgraded name specified.
public ScheduledExecutorService	getUtilityExecutor() Implements org.apache.coyote.ProtocolHandler.getUtilityExecutor. Get the utility executor that should be used by the protocol handler.
public int	getWaitingProcessorCount()
public void	init() Implements org.apache.coyote.ProtocolHandler.init. Initialise the protocol.
public boolean	isPaused()
public boolean	isSendfileSupported() Implements org.apache.coyote.ProtocolHandler.isSendfileSupported. Does this ProtocolHandler support sendfile?
private void	logPortOffset()
public void	pause() Implements org.apache.coyote.ProtocolHandler.pause. Pause the protocol (optional).
public void	postDeregister() Implements javax.management.MBeanRegistration.postDeregister. Allows the MBean to perform any operations needed after having been unregistered in the MBean server.
public void	postRegister(Boolean Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed. registrationDone) Implements javax.management.MBeanRegistration.postRegister. Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
public void	preDeregister() Implements javax.management.MBeanRegistration.preDeregister. Allows the MBean to perform any operations it needs before being unregistered by the MBean server.
public ObjectName	preRegister(MBeanServer The MBean Server in which the MBean will be registered. server, ObjectName The object name of the MBean. This name is null if the name parameter to one of the `createMBean` or `registerMBean` methods in the `MBeanServer` interface is null. In that case, this method must return a non-null ObjectName for the new MBean. name) Implements javax.management.MBeanRegistration.preRegister. Allows the MBean to perform any operations it needs before being registered in the MBean Server.
public void	removeWaitingProcessor(Processor processor)
public void	resume() Implements org.apache.coyote.ProtocolHandler.resume. Resume the protocol (optional).
public void	setAcceptCount(int acceptCount)
public void	setAcceptorThreadPriority(int threadPriority)
public void	setAdapter(Adapter The adapter to associate adapter) Implements org.apache.coyote.ProtocolHandler.setAdapter. The adapter, used to call the connector.
public void	setAddress(InetAddress ia)
public void	setClientCertProvider(String s)
public void	setConnectionLinger(int connectionLinger)
public void	setConnectionTimeout(int timeout)
public void	setExecutor(Executor the executor executor) Implements org.apache.coyote.ProtocolHandler.setExecutor. Set the optional executor that will be used by the connector.
protected void	setHandler(AbstractEndpoint.Handler<S> handler)
public void	setKeepAliveTimeout(int keepAliveTimeout)
public void	setMaxConnections(int maxConnections)
public void	setMaxHeaderCount(int maxHeaderCount)
public void	setMaxThreads(int maxThreads)
public void	setMinSpareThreads(int minSpareThreads)
public void	setPort(int port)
public void	setPortOffset(int portOffset)
public void	setProcessorCache(int processorCache)
public boolean	Returns: `true` if the property was set successfully, otherwise `false` setProperty(String The name of the property to set name, String The value, in string form, to set for the property value) Generic property setter used by the digester.
public void	setTcpNoDelay(boolean tcpNoDelay)
public void	setThreadPriority(int threadPriority)
public void	setUtilityExecutor(ScheduledExecutorService the executor utilityExecutor) Implements org.apache.coyote.ProtocolHandler.setUtilityExecutor. Set the utility executor that should be used by the protocol handler.
public void	start() Implements org.apache.coyote.ProtocolHandler.start. Start the protocol.
protected void	startAsyncTimeout() Note The name of this method originated with the Servlet 3.0 asynchronous processing but evolved over time to represent a timeout that is triggered independently of the socket read/write timeouts.
public void	stop() Implements org.apache.coyote.ProtocolHandler.stop. Stop the protocol.
protected void	stopAsyncTimeout()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public abstract Class AbstractProtocol<S>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary