AbstractAjpProtocol
, AbstractHttp11JsseProtocol
, AbstractHttp11Protocol
, AbstractProtocol
, AjpAprProtocol
, AjpNio2Protocol
, AjpNioProtocol
, Http11AprProtocol
, Http11Nio2Protocol
, Http11NioProtocol
public interface ProtocolHandler
Adapter
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.
|
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.
|
java.util.concurrent.ScheduledExecutorService |
getUtilityExecutor() |
Get the utility executor that should be used by the protocol handler.
|
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 |
resume() |
Resume the protocol (optional).
|
void |
setAdapter(Adapter adapter) |
The adapter, used to call the connector.
|
void |
setExecutor(java.util.concurrent.Executor executor) |
Set the optional executor that will be used by the connector.
|
void |
setUtilityExecutor(java.util.concurrent.ScheduledExecutorService utilityExecutor) |
Set the utility executor that should be used by the protocol handler.
|
void |
start() |
Start the protocol.
|
void |
stop() |
Stop the protocol.
|
Adapter getAdapter()
void setAdapter(Adapter adapter)
adapter
- The adapter to associatejava.util.concurrent.Executor getExecutor()
void setExecutor(java.util.concurrent.Executor executor)
executor
- the executorjava.util.concurrent.ScheduledExecutorService getUtilityExecutor()
void setUtilityExecutor(java.util.concurrent.ScheduledExecutorService utilityExecutor)
utilityExecutor
- the executorvoid init() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to initialisevoid start() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to startvoid pause() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to pausevoid resume() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to resumevoid stop() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to stopvoid destroy() throws java.lang.Exception
java.lang.Exception
- If the protocol handler fails to destroyvoid closeServerSocketGraceful()
boolean isAprRequired()
true
if this Protocol Handler requires the
APR/native library, otherwise false
boolean isSendfileSupported()
true
if this Protocol Handler supports sendfile,
otherwise false
void addSslHostConfig(SSLHostConfig sslHostConfig)
sslHostConfig
- the configurationSSLHostConfig[] findSslHostConfigs()
void addUpgradeProtocol(UpgradeProtocol upgradeProtocol)
upgradeProtocol
- the protocolUpgradeProtocol[] findUpgradeProtocols()
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.