Package org.apache.coyote
Interface ProtocolHandler
-
- All Known Implementing Classes:
AbstractAjpProtocol
,AbstractHttp11JsseProtocol
,AbstractHttp11Protocol
,AbstractProtocol
,AjpAprProtocol
,AjpNio2Protocol
,AjpNioProtocol
,AjpProtocol
,Http11AprProtocol
,Http11Nio2Protocol
,Http11NioProtocol
,Http11Protocol
public interface ProtocolHandler
Abstract 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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addSslHostConfig(SSLHostConfig sslHostConfig)
Add a new SSL configuration for a virtual host.void
addUpgradeProtocol(UpgradeProtocol upgradeProtocol)
Add a new protocol for used by HTTP/1.1 upgrade or ALPN.long
awaitConnectionsClose(long waitMillis)
Wait for the client connections to the server to close gracefully.void
closeServerSocketGraceful()
void
destroy()
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.Adapter
getAdapter()
Return the adapter associated with the protocol handler.java.util.concurrent.Executor
getExecutor()
The executor, provide access to the underlying thread pool.void
init()
Initialise the protocol.boolean
isAprRequired()
Deprecated.This method will be removed in Tomcat 10.1.x onwardsboolean
isSendfileSupported()
Does this ProtocolHandler support sendfile?void
pause()
Pause the protocol (optional).void
resume()
Resume the protocol (optional).void
setAdapter(Adapter adapter)
The adapter, used to call the connector.void
start()
Start the protocol.void
stop()
Stop the protocol.
-
-
-
Method Detail
-
getAdapter
Adapter getAdapter()
Return the adapter associated with the protocol handler.- Returns:
- the adapter
-
setAdapter
void setAdapter(Adapter adapter)
The adapter, used to call the connector.- Parameters:
adapter
- The adapter to associate
-
getExecutor
java.util.concurrent.Executor getExecutor()
The executor, provide access to the underlying thread pool.- Returns:
- The executor used to process requests
-
init
void init() throws java.lang.Exception
Initialise the protocol.- Throws:
java.lang.Exception
- If the protocol handler fails to initialise
-
start
void start() throws java.lang.Exception
Start the protocol.- Throws:
java.lang.Exception
- If the protocol handler fails to start
-
pause
void pause() throws java.lang.Exception
Pause the protocol (optional).- Throws:
java.lang.Exception
- If the protocol handler fails to pause
-
resume
void resume() throws java.lang.Exception
Resume the protocol (optional).- Throws:
java.lang.Exception
- If the protocol handler fails to resume
-
stop
void stop() throws java.lang.Exception
Stop the protocol.- Throws:
java.lang.Exception
- If the protocol handler fails to stop
-
destroy
void destroy() throws java.lang.Exception
Destroy the protocol (optional).- Throws:
java.lang.Exception
- If the protocol handler fails to destroy
-
closeServerSocketGraceful
void closeServerSocketGraceful()
-
awaitConnectionsClose
long 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:
true
if this Protocol Handler requires the APR/native library, otherwisefalse
-
isSendfileSupported
boolean isSendfileSupported()
Does this ProtocolHandler support sendfile?- Returns:
true
if this Protocol Handler supports sendfile, otherwisefalse
-
addSslHostConfig
void addSslHostConfig(SSLHostConfig sslHostConfig)
Add a new SSL configuration for a virtual host.- Parameters:
sslHostConfig
- the configuration
-
findSslHostConfigs
SSLHostConfig[] findSslHostConfigs()
Find all configured SSL virtual host configurations which will be used by SNI.- Returns:
- the configurations
-
addUpgradeProtocol
void addUpgradeProtocol(UpgradeProtocol upgradeProtocol)
Add a new protocol for used by HTTP/1.1 upgrade or ALPN.- Parameters:
upgradeProtocol
- the protocol
-
findUpgradeProtocols
UpgradeProtocol[] findUpgradeProtocols()
Return all configured upgrade protocols.- Returns:
- the protocols
-
-