Package org.apache.coyote.ajp
Class AbstractAjpProtocol<S>
java.lang.Object
org.apache.coyote.AbstractProtocol<S>
org.apache.coyote.ajp.AbstractAjpProtocol<S>
- Type Parameters:
S
- The type of socket used by the implementation
- All Implemented Interfaces:
MBeanRegistration
,ProtocolHandler
- Direct Known Subclasses:
AjpAprProtocol
,AjpNio2Protocol
,AjpNioProtocol
The is the base implementation for the AJP protocol handlers. Implementations typically extend this base class rather
than implement
ProtocolHandler
. All of the implementations that ship with Tomcat are
implemented this way.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.coyote.AbstractProtocol
AbstractProtocol.AsyncTimeout, AbstractProtocol.ConnectionHandler<S>, AbstractProtocol.RecycledProcessors
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected static final StringManager
The string manager for this package.Fields inherited from class org.apache.coyote.AbstractProtocol
adapter, clientCertProvider, domain, mserver, oname, processorCache, rgOname
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addSslHostConfig
(SSLHostConfig sslHostConfig) Add a new SSL configuration for a virtual host.void
addSslHostConfig
(SSLHostConfig sslHostConfig, boolean replace) 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.protected Processor
Create and configure a new Processor instance for the current protocol implementation.protected Processor
createUpgradeProcessor
(SocketWrapperBase<?> socket, UpgradeToken upgradeToken) Find all configured SSL virtual host configurations which will be used by SNI.Return all configured upgrade protocols.boolean
protected Pattern
protected AbstractEndpoint<S,
?> Overridden to make getter accessible to other classes in this package.protected UpgradeProtocol
getNegotiatedProtocol
(String name) Find a suitable handler for the protocol negotiated at the network layer.int
protected String
Obtain the name of the protocol, (Http, Ajp, etc.).protected String
Deprecated.protected String
boolean
boolean
Should authentication be done in the native web server layer, or in the Servlet container ?boolean
Should authentication be done in the native web server layer and authorization in the Servlet container?protected UpgradeProtocol
getUpgradeProtocol
(String name) Find a suitable handler for the protocol upgraded name specified.void
setAjpFlush
(boolean ajpFlush) Configure whether to aend an AJP flush packet when flushing.void
setAllowedRequestAttributesPattern
(String allowedRequestAttributesPattern) void
setPacketSize
(int packetSize) void
setRequiredSecret
(String requiredSecret) Deprecated.Replaced bysetSecret(String)
.void
Set the secret that must be included with every request.void
setSecretRequired
(boolean secretRequired) void
setTomcatAuthentication
(boolean tomcatAuthentication) void
setTomcatAuthorization
(boolean tomcatAuthorization) void
start()
Start the protocol.Methods inherited from class org.apache.coyote.AbstractProtocol
addWaitingProcessor, awaitConnectionsClose, closeServerSocketGraceful, destroy, getAcceptCount, getAcceptorThreadCount, getAcceptorThreadPriority, getAdapter, getAddress, getAsyncTimeout, getBacklog, getClientCertProvider, getConnectionCount, getConnectionLinger, getConnectionTimeout, getDomain, getExecutor, getGlobalRequestProcessorMBeanName, getHandler, getKeepAliveTimeout, getLocalPort, getLog, getMaxConnections, getMaxHeaderCount, getMaxThreads, getMinSpareThreads, getName, getNameIndex, getNamePrefix, getObjectName, getPort, getPortOffset, getPortWithOffset, getProcessorCache, getProperty, getSendReasonPhrase, getSoLinger, getSoTimeout, getTcpNoDelay, getThreadPriority, getWaitingProcessorCount, init, isAprRequired, isSendfileSupported, pause, postDeregister, postRegister, preDeregister, preRegister, removeWaitingProcessor, resume, setAcceptCount, setAcceptorThreadCount, setAcceptorThreadPriority, setAdapter, setAddress, setBacklog, setClientCertProvider, setConnectionLinger, setConnectionTimeout, setExecutor, setHandler, setKeepAliveTimeout, setMaxConnections, setMaxHeaderCount, setMaxThreads, setMinSpareThreads, setPort, setPortOffset, setProcessorCache, setProperty, setSendReasonPhrase, setSoLinger, setSoTimeout, setTcpNoDelay, setThreadPriority, stop
-
Field Details
-
sm
The string manager for this package. -
ajpFlush
protected boolean ajpFlush
-
-
Constructor Details
-
AbstractAjpProtocol
-
-
Method Details
-
getProtocolName
Description copied from class:AbstractProtocol
Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX.- Specified by:
getProtocolName
in classAbstractProtocol<S>
- Returns:
- the protocol name
-
getEndpoint
Overridden to make getter accessible to other classes in this package.- Overrides:
getEndpoint
in classAbstractProtocol<S>
-
getNegotiatedProtocol
Find a suitable handler for the protocol negotiated at the network layer. AJP does not support protocol negotiation so this always returns null.- Specified by:
getNegotiatedProtocol
in classAbstractProtocol<S>
- Parameters:
name
- The name of the requested negotiated protocol.- Returns:
- The instance where
UpgradeProtocol.getAlpnName()
matches the requested protocol
-
getUpgradeProtocol
Find a suitable handler for the protocol upgraded name specified. This is used for direct connection protocol selection. AJP does not support protocol upgrade so this always returns null.- Specified by:
getUpgradeProtocol
in classAbstractProtocol<S>
- Parameters:
name
- The name of the requested negotiated protocol.- Returns:
- The instance where
UpgradeProtocol.getAlpnName()
matches the requested protocol
-
getAjpFlush
public boolean getAjpFlush() -
setAjpFlush
public void setAjpFlush(boolean ajpFlush) Configure whether to aend an AJP flush packet when flushing. A flush packet is a zero byte AJP13 SEND_BODY_CHUNK packet. mod_jk and mod_proxy_ajp interpret this as a request to flush data to the client. AJP always does flush at the and of the response, so if it is not important, that the packets get streamed up to the client, do not use extra flush packets. For compatibility and to stay on the safe side, flush packets are enabled by default.- Parameters:
ajpFlush
- The new flush setting
-
getTomcatAuthentication
public boolean getTomcatAuthentication()Should authentication be done in the native web server layer, or in the Servlet container ?- Returns:
true
if authentication should be performed by Tomcat, otherwisefalse
-
setTomcatAuthentication
public void setTomcatAuthentication(boolean tomcatAuthentication) -
getTomcatAuthorization
public boolean getTomcatAuthorization()Should authentication be done in the native web server layer and authorization in the Servlet container?- Returns:
true
if authorization should be performed by Tomcat, otherwisefalse
-
setTomcatAuthorization
public void setTomcatAuthorization(boolean tomcatAuthorization) -
setSecret
Set the secret that must be included with every request.- Parameters:
secret
- The required secret
-
getSecret
-
setRequiredSecret
Deprecated.Replaced bysetSecret(String)
. Will be removed in Tomcat 11 onwardsSet the required secret that must be included with every request.- Parameters:
requiredSecret
- The required secret
-
getRequiredSecret
Deprecated.Replaced bygetSecret()
. Will be removed in Tomcat 11 onwards- Returns:
- The current secret
-
setSecretRequired
public void setSecretRequired(boolean secretRequired) -
getSecretRequired
public boolean getSecretRequired() -
setAllowedRequestAttributesPattern
-
getAllowedRequestAttributesPattern
-
getAllowedRequestAttributesPatternInternal
-
getPacketSize
public int getPacketSize() -
setPacketSize
public void setPacketSize(int packetSize) -
addSslHostConfig
Description copied from interface:ProtocolHandler
Add a new SSL configuration for a virtual host.- Parameters:
sslHostConfig
- the configuration
-
addSslHostConfig
Description copied from interface:ProtocolHandler
Add a new SSL configuration for a virtual host.- Parameters:
sslHostConfig
- the configurationreplace
- Iftrue
replacement of an existing configuration is permitted, otherwise any such attempted replacement will trigger an exception
-
findSslHostConfigs
Description copied from interface:ProtocolHandler
Find all configured SSL virtual host configurations which will be used by SNI.- Returns:
- the configurations
-
addUpgradeProtocol
Description copied from interface:ProtocolHandler
Add a new protocol for used by HTTP/1.1 upgrade or ALPN.- Parameters:
upgradeProtocol
- the protocol
-
findUpgradeProtocols
Description copied from interface:ProtocolHandler
Return all configured upgrade protocols.- Returns:
- the protocols
-
createProcessor
Description copied from class:AbstractProtocol
Create and configure a new Processor instance for the current protocol implementation.- Specified by:
createProcessor
in classAbstractProtocol<S>
- Returns:
- A fully configured Processor instance that is ready to use
-
createUpgradeProcessor
- Specified by:
createUpgradeProcessor
in classAbstractProtocol<S>
-
start
Description copied from interface:ProtocolHandler
Start the protocol.- Specified by:
start
in interfaceProtocolHandler
- Overrides:
start
in classAbstractProtocol<S>
- Throws:
Exception
- If the protocol handler fails to start
-
getSecret()
.