Package org.apache.coyote
Interface ProtocolHandler
- 
- All Known Implementing Classes:
- AbstractAjpProtocol,- AbstractHttp11JsseProtocol,- AbstractHttp11Protocol,- AbstractProtocol,- AjpAprProtocol,- AjpNio2Protocol,- AjpNioProtocol,- AjpProtocol,- Http11AprProtocol,- Http11Nio2Protocol,- Http11NioProtocol,- Http11Protocol
 
 public interface ProtocolHandlerAbstract the protocol implementation, including threading, etc. This is the main interface to be implemented by a coyote protocol. Adapter is the main interface to be implemented by a coyote servlet container.- Author:
- Remy Maucherat, Costin Manolache
- See Also:
- Adapter
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidaddSslHostConfig(SSLHostConfig sslHostConfig)Add a new SSL configuration for a virtual host.voidaddUpgradeProtocol(UpgradeProtocol upgradeProtocol)Add a new protocol for used by HTTP/1.1 upgrade or ALPN.longawaitConnectionsClose(long waitMillis)Wait for the client connections to the server to close gracefully.voidcloseServerSocketGraceful()voiddestroy()Destroy the protocol (optional).SSLHostConfig[]findSslHostConfigs()Find all configured SSL virtual host configurations which will be used by SNI.UpgradeProtocol[]findUpgradeProtocols()Return all configured upgrade protocols.AdaptergetAdapter()Return the adapter associated with the protocol handler.java.util.concurrent.ExecutorgetExecutor()The executor, provide access to the underlying thread pool.voidinit()Initialise the protocol.booleanisAprRequired()Deprecated.This method will be removed in Tomcat 10.1.x onwardsbooleanisSendfileSupported()Does this ProtocolHandler support sendfile?voidpause()Pause the protocol (optional).voidresume()Resume the protocol (optional).voidsetAdapter(Adapter adapter)The adapter, used to call the connector.voidstart()Start the protocol.voidstop()Stop the protocol.
 
- 
- 
- 
Method Detail- 
getAdapterAdapter getAdapter() Return the adapter associated with the protocol handler.- Returns:
- the adapter
 
 - 
setAdaptervoid setAdapter(Adapter adapter) The adapter, used to call the connector.- Parameters:
- adapter- The adapter to associate
 
 - 
getExecutorjava.util.concurrent.Executor getExecutor() The executor, provide access to the underlying thread pool.- Returns:
- The executor used to process requests
 
 - 
initvoid init() throws java.lang.Exception Initialise the protocol.- Throws:
- java.lang.Exception- If the protocol handler fails to initialise
 
 - 
startvoid start() throws java.lang.ExceptionStart the protocol.- Throws:
- java.lang.Exception- If the protocol handler fails to start
 
 - 
pausevoid pause() throws java.lang.ExceptionPause the protocol (optional).- Throws:
- java.lang.Exception- If the protocol handler fails to pause
 
 - 
resumevoid resume() throws java.lang.ExceptionResume the protocol (optional).- Throws:
- java.lang.Exception- If the protocol handler fails to resume
 
 - 
stopvoid stop() throws java.lang.Exception Stop the protocol.- Throws:
- java.lang.Exception- If the protocol handler fails to stop
 
 - 
destroyvoid destroy() throws java.lang.ExceptionDestroy the protocol (optional).- Throws:
- java.lang.Exception- If the protocol handler fails to destroy
 
 - 
closeServerSocketGracefulvoid closeServerSocketGraceful() 
 - 
awaitConnectionsCloselong awaitConnectionsClose(long waitMillis) Wait for the client connections to the server to close gracefully. The method will return when all of the client connections have closed or the method has been waiting forwaitTimeMillis.- Parameters:
- waitMillis- The maximum time to wait in milliseconds for the client connections to close.
- Returns:
- The wait time, if any remaining when the method returned
 
 - 
isAprRequired@Deprecated boolean isAprRequired() Deprecated.This method will be removed in Tomcat 10.1.x onwardsRequires APR/native library- Returns:
- trueif this Protocol Handler requires the APR/native library, otherwise- false
 
 - 
isSendfileSupportedboolean isSendfileSupported() Does this ProtocolHandler support sendfile?- Returns:
- trueif this Protocol Handler supports sendfile, otherwise- false
 
 - 
addSslHostConfigvoid addSslHostConfig(SSLHostConfig sslHostConfig) Add a new SSL configuration for a virtual host.- Parameters:
- sslHostConfig- the configuration
 
 - 
findSslHostConfigsSSLHostConfig[] findSslHostConfigs() Find all configured SSL virtual host configurations which will be used by SNI.- Returns:
- the configurations
 
 - 
addUpgradeProtocolvoid addUpgradeProtocol(UpgradeProtocol upgradeProtocol) Add a new protocol for used by HTTP/1.1 upgrade or ALPN.- Parameters:
- upgradeProtocol- the protocol
 
 - 
findUpgradeProtocolsUpgradeProtocol[] findUpgradeProtocols() Return all configured upgrade protocols.- Returns:
- the protocols
 
 
- 
 
-