Tomcat 10.1.19 · org.apache.coyote.ajp.AbstractAjpProtocol

Modifier and Type	Field and Description
private boolean	ajpFlush
private Pattern	allowedRequestAttributesPattern
private int	packetSize AJP packet size.
private String	secret
private boolean	secretRequired
protected static final StringManager	sm Hides org.apache.coyote.AbstractProtocol.sm. The string manager for this package.
private boolean	tomcatAuthentication
private boolean	tomcatAuthorization

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

Method Summary

Modifier and Type	Method and Description
public void	addSslHostConfig(SSLHostConfig the configuration sslHostConfig) Implements org.apache.coyote.ProtocolHandler.addSslHostConfig. Add a new SSL configuration for a virtual host.
public void	addSslHostConfig(SSLHostConfig the configuration sslHostConfig, boolean If `true` replacement of an existing configuration is permitted, otherwise any such attempted replacement will trigger an exception replace) Implements org.apache.coyote.ProtocolHandler.addSslHostConfig. Add a new SSL configuration for a virtual host.
public void	addUpgradeProtocol(UpgradeProtocol the protocol upgradeProtocol) Implements org.apache.coyote.ProtocolHandler.addUpgradeProtocol. Add a new protocol for used by HTTP/1.1 upgrade or ALPN.
protected Processor	createProcessor() Implements abstract org.apache.coyote.AbstractProtocol.createProcessor. Create and configure a new Processor instance for the current protocol implementation.
protected Processor	createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken) Implements abstract org.apache.coyote.AbstractProtocol.createUpgradeProcessor.
public SSLHostConfig[]	findSslHostConfigs() Implements org.apache.coyote.ProtocolHandler.findSslHostConfigs. Find all configured SSL virtual host configurations which will be used by SNI.
public UpgradeProtocol[]	findUpgradeProtocols() Implements org.apache.coyote.ProtocolHandler.findUpgradeProtocols. Return all configured upgrade protocols.
public boolean	getAjpFlush()
public String	getAllowedRequestAttributesPattern()
protected Pattern	getAllowedRequestAttributesPatternInternal()
public int	getDesiredBufferSize() Overrides default org.apache.coyote.ProtocolHandler.getDesiredBufferSize. Some protocols, like AJP, have a packet length that shouldn't be exceeded, and this can be used to adjust the buffering used by the application layer.
protected AbstractEndpoint<S, ?>	getEndpoint() Overrides org.apache.coyote.AbstractProtocol.getEndpoint. Overridden to make getter accessible to other classes in this package.
protected UpgradeProtocol	getNegotiatedProtocol(String The name of the requested negotiated protocol. name) Implements abstract org.apache.coyote.AbstractProtocol.getNegotiatedProtocol. Find a suitable handler for the protocol negotiated at the network layer.
public int	getPacketSize()
protected String	getProtocolName() Implements abstract org.apache.coyote.AbstractProtocol.getProtocolName. Obtain the name of the protocol, (Http, Ajp, etc.).
protected String	Returns: The current secret getRequiredSecret() Deprecated Replaced by `getSecret()`. Will be removed in Tomcat 11 onwards
protected String	getSecret()
public boolean	getSecretRequired()
public boolean	Returns: `true` if authentication should be performed by Tomcat, otherwise `false` getTomcatAuthentication() Should authentication be done in the native web server layer, or in the Servlet container ?
public boolean	Returns: `true` if authorization should be performed by Tomcat, otherwise `false` getTomcatAuthorization() Should authentication be done in the native web server layer and authorization in the Servlet container?
protected UpgradeProtocol	getUpgradeProtocol(String The name of the requested negotiated protocol. name) Implements abstract org.apache.coyote.AbstractProtocol.getUpgradeProtocol. Find a suitable handler for the protocol upgraded name specified.
public void	setAjpFlush(boolean The new flush setting ajpFlush) Configure whether to aend an AJP flush packet when flushing.
public void	setAllowedRequestAttributesPattern(String allowedRequestAttributesPattern)
public void	setPacketSize(int packetSize)
public void	setRequiredSecret(String The required secret requiredSecret) Deprecated Replaced by `setSecret(String)`. Will be removed in Tomcat 11 onwards Set the required secret that must be included with every request.
public void	setSecret(String The required secret secret) Set the secret that must be included with every request.
public void	setSecretRequired(boolean secretRequired)
public void	setTomcatAuthentication(boolean tomcatAuthentication)
public void	setTomcatAuthorization(boolean tomcatAuthorization)
public void	start() Overrides org.apache.coyote.AbstractProtocol.start. Implements org.apache.coyote.ProtocolHandler.start. Start the protocol.

Inherited from org.apache.coyote.AbstractProtocol:: addWaitingProcessor awaitConnectionsClose closeServerSocketGraceful destroy getAcceptCount getAcceptorThreadPriority getAdapter getAddress getClientCertProvider getConnectionCount getConnectionLinger getConnectionTimeout getDomain getExecutor getGlobalRequestProcessorMBeanName getHandler getId getKeepAliveTimeout getLocalPort getLog getMaxConnections getMaxHeaderCount getMaxThreads getMinSpareThreads getName getNameIndex getNamePrefix getObjectName getPort getPortOffset getPortWithOffset getProcessorCache getProperty getTcpNoDelay getThreadPriority getUtilityExecutor getWaitingProcessorCount init isPaused isSendfileSupported pause postDeregister postRegister preDeregister preRegister removeWaitingProcessor resume setAcceptCount setAcceptorThreadPriority setAdapter setAddress setClientCertProvider setConnectionLinger setConnectionTimeout setExecutor setHandler setKeepAliveTimeout setMaxConnections setMaxHeaderCount setMaxThreads setMinSpareThreads setPort setPortOffset setProcessorCache setProperty setTcpNoDelay setThreadPriority setUtilityExecutor startAsyncTimeout stop stopAsyncTimeout

ajpFlush	back to summary
private boolean ajpFlush

allowedRequestAttributesPattern	back to summary
private Pattern allowedRequestAttributesPattern

packetSize	back to summary
private int packetSize AJP packet size.

secret	back to summary
private String secret

secretRequired	back to summary
private boolean secretRequired

sm	back to summary
protected static final StringManager sm Hides org.apache.coyote.AbstractProtocol.sm. The string manager for this package.

tomcatAuthentication	back to summary
private boolean tomcatAuthentication

tomcatAuthorization	back to summary
private boolean tomcatAuthorization

AbstractAjpProtocol	back to summary
public AbstractAjpProtocol(AbstractEndpoint<S, ?> endpoint)

Method Detail

addSslHostConfig	back to summary
public void addSslHostConfig(SSLHostConfig sslHostConfig) Implements org.apache.coyote.ProtocolHandler.addSslHostConfig. Doc from org.apache.coyote.ProtocolHandler.addSslHostConfig. Add a new SSL configuration for a virtual host. Parameters sslHostConfig:SSLHostConfig the configuration Annotations @Override

addSslHostConfig

back to summary

public void addSslHostConfig(SSLHostConfig sslHostConfig)

Implements org.apache.coyote.ProtocolHandler.addSslHostConfig.

Doc from org.apache.coyote.ProtocolHandler.addSslHostConfig.

Add a new SSL configuration for a virtual host.

Parameters

sslHostConfig:SSLHostConfig: the configuration

Annotations

@Override

addSslHostConfig back to summary

addSslHostConfig	back to summary
public void addSslHostConfig(SSLHostConfig sslHostConfig, boolean replace) Implements org.apache.coyote.ProtocolHandler.addSslHostConfig. Doc from org.apache.coyote.ProtocolHandler.addSslHostConfig. Add a new SSL configuration for a virtual host. Parameters sslHostConfig:SSLHostConfig the configuration replace:boolean If `true` replacement of an existing configuration is permitted, otherwise any such attempted replacement will trigger an exception Annotations @Override

public void addSslHostConfig(SSLHostConfig sslHostConfig, boolean replace)

Implements org.apache.coyote.ProtocolHandler.addSslHostConfig.

Doc from org.apache.coyote.ProtocolHandler.addSslHostConfig.

Add a new SSL configuration for a virtual host.

Parameters

sslHostConfig:SSLHostConfig: the configuration
replace:boolean: If true replacement of an existing configuration is permitted, otherwise any such attempted replacement will trigger an exception

Annotations

@Override

addUpgradeProtocol	back to summary
public void addUpgradeProtocol(UpgradeProtocol upgradeProtocol) Implements org.apache.coyote.ProtocolHandler.addUpgradeProtocol. Doc from org.apache.coyote.ProtocolHandler.addUpgradeProtocol. Add a new protocol for used by HTTP/1.1 upgrade or ALPN. Parameters upgradeProtocol:UpgradeProtocol the protocol Annotations @Override

addUpgradeProtocol

back to summary

public void addUpgradeProtocol(UpgradeProtocol upgradeProtocol)

Implements org.apache.coyote.ProtocolHandler.addUpgradeProtocol.

Doc from org.apache.coyote.ProtocolHandler.addUpgradeProtocol.

Add a new protocol for used by HTTP/1.1 upgrade or ALPN.

Parameters

upgradeProtocol:UpgradeProtocol: the protocol

Annotations

@Override

createProcessor	back to summary
protected Processor createProcessor() Implements abstract org.apache.coyote.AbstractProtocol.createProcessor. Doc from org.apache.coyote.AbstractProtocol.createProcessor. Create and configure a new Processor instance for the current protocol implementation. Returns:Processor A fully configured Processor instance that is ready to use Annotations @Override

createProcessor

back to summary

protected Processor createProcessor()

Implements abstract org.apache.coyote.AbstractProtocol.createProcessor.

Doc from org.apache.coyote.AbstractProtocol.createProcessor.

Create and configure a new Processor instance for the current protocol implementation.

Returns:Processor

A fully configured Processor instance that is ready to use

Annotations

@Override

createUpgradeProcessor	back to summary
protected Processor createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken) Implements abstract org.apache.coyote.AbstractProtocol.createUpgradeProcessor. Annotations @Override

createUpgradeProcessor

back to summary

protected Processor createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken)

Implements abstract org.apache.coyote.AbstractProtocol.createUpgradeProcessor.

Annotations

@Override

findSslHostConfigs	back to summary
public SSLHostConfig[] findSslHostConfigs() Implements org.apache.coyote.ProtocolHandler.findSslHostConfigs. Doc from org.apache.coyote.ProtocolHandler.findSslHostConfigs. Find all configured SSL virtual host configurations which will be used by SNI. Returns:SSLHostConfig[] the configurations Annotations @Override

findSslHostConfigs

back to summary

public SSLHostConfig[] findSslHostConfigs()

Implements org.apache.coyote.ProtocolHandler.findSslHostConfigs.

Doc from org.apache.coyote.ProtocolHandler.findSslHostConfigs.

Find all configured SSL virtual host configurations which will be used by SNI.

Returns:SSLHostConfig[]

the configurations

Annotations

@Override

findUpgradeProtocols	back to summary
public UpgradeProtocol[] findUpgradeProtocols() Implements org.apache.coyote.ProtocolHandler.findUpgradeProtocols. Doc from org.apache.coyote.ProtocolHandler.findUpgradeProtocols. Return all configured upgrade protocols. Returns:UpgradeProtocol[] the protocols Annotations @Override

findUpgradeProtocols

back to summary

public UpgradeProtocol[] findUpgradeProtocols()

Implements org.apache.coyote.ProtocolHandler.findUpgradeProtocols.

Doc from org.apache.coyote.ProtocolHandler.findUpgradeProtocols.

Return all configured upgrade protocols.

Returns:UpgradeProtocol[]

the protocols

Annotations

@Override

getAjpFlush	back to summary
public boolean getAjpFlush()

getAllowedRequestAttributesPattern	back to summary
public String getAllowedRequestAttributesPattern()

getAllowedRequestAttributesPatternInternal	back to summary
protected Pattern getAllowedRequestAttributesPatternInternal()

getDesiredBufferSize	back to summary
public int getDesiredBufferSize() Overrides default org.apache.coyote.ProtocolHandler.getDesiredBufferSize. Doc from org.apache.coyote.ProtocolHandler.getDesiredBufferSize. Some protocols, like AJP, have a packet length that shouldn't be exceeded, and this can be used to adjust the buffering used by the application layer. Returns:int the desired buffer size, or -1 if not relevant Annotations @Override

getDesiredBufferSize

back to summary

public int getDesiredBufferSize()

Overrides default org.apache.coyote.ProtocolHandler.getDesiredBufferSize.

Doc from org.apache.coyote.ProtocolHandler.getDesiredBufferSize.

Some protocols, like AJP, have a packet length that shouldn't be exceeded, and this can be used to adjust the buffering used by the application layer.

Returns:int

the desired buffer size, or -1 if not relevant

Annotations

@Override

getEndpoint	back to summary
protected AbstractEndpoint<S, ?> getEndpoint() Overrides org.apache.coyote.AbstractProtocol.getEndpoint. Overridden to make getter accessible to other classes in this package. Annotations @Override

getEndpoint

back to summary

protected AbstractEndpoint<S, ?> getEndpoint()

Overrides org.apache.coyote.AbstractProtocol.getEndpoint.

Overridden to make getter accessible to other classes in this package.

Annotations

@Override

getNegotiatedProtocol back to summary

getNegotiatedProtocol	back to summary
protected UpgradeProtocol getNegotiatedProtocol(String name) Implements abstract org.apache.coyote.AbstractProtocol.getNegotiatedProtocol. Doc from org.apache.coyote.AbstractProtocol.getNegotiatedProtocol. Find a suitable handler for the protocol negotiated at the network layer. AJP does not support protocol negotiation so this always returns null. Parameters name:String The name of the requested negotiated protocol. Returns:UpgradeProtocol The instance where `UpgradeProtocol#getAlpnName()` matches the requested protocol Annotations @Override

protected UpgradeProtocol getNegotiatedProtocol(String name)

Implements abstract org.apache.coyote.AbstractProtocol.getNegotiatedProtocol.

Doc from org.apache.coyote.AbstractProtocol.getNegotiatedProtocol.

Find a suitable handler for the protocol negotiated at the network layer. AJP does not support protocol negotiation so this always returns null.

Parameters

name:String: The name of the requested negotiated protocol.

Returns:UpgradeProtocol

The instance where UpgradeProtocol#getAlpnName() matches the requested protocol

Annotations

@Override

getPacketSize	back to summary
public int getPacketSize()

getProtocolName	back to summary
protected String getProtocolName() Implements abstract org.apache.coyote.AbstractProtocol.getProtocolName. Doc from org.apache.coyote.AbstractProtocol.getProtocolName. Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX. Returns:String the protocol name Annotations @Override

getProtocolName

back to summary

protected String getProtocolName()

Implements abstract org.apache.coyote.AbstractProtocol.getProtocolName.

Doc from org.apache.coyote.AbstractProtocol.getProtocolName.

Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX.

Returns:String

the protocol name

Annotations

@Override

getRequiredSecret	back to summary
protected String getRequiredSecret() Deprecated Replaced by `getSecret()`. Will be removed in Tomcat 11 onwards Returns:String The current secret Annotations @Deprecated

getSecret	back to summary
protected String getSecret()

getSecretRequired	back to summary
public boolean getSecretRequired()

getTomcatAuthentication back to summary

getTomcatAuthentication	back to summary
public boolean getTomcatAuthentication() Should authentication be done in the native web server layer, or in the Servlet container ? Returns:boolean `true` if authentication should be performed by Tomcat, otherwise `false`

public boolean getTomcatAuthentication()

Should authentication be done in the native web server layer, or in the Servlet container ?

Returns:boolean: true if authentication should be performed by Tomcat, otherwise false

getTomcatAuthorization back to summary

getTomcatAuthorization	back to summary
public boolean getTomcatAuthorization() Should authentication be done in the native web server layer and authorization in the Servlet container? Returns:boolean `true` if authorization should be performed by Tomcat, otherwise `false`

public boolean getTomcatAuthorization()

Should authentication be done in the native web server layer and authorization in the Servlet container?

Returns:boolean: true if authorization should be performed by Tomcat, otherwise false

getUpgradeProtocol back to summary

getUpgradeProtocol	back to summary
protected UpgradeProtocol getUpgradeProtocol(String name) Implements abstract org.apache.coyote.AbstractProtocol.getUpgradeProtocol. Doc from org.apache.coyote.AbstractProtocol.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. Parameters name:String The name of the requested negotiated protocol. Returns:UpgradeProtocol The instance where `UpgradeProtocol#getAlpnName()` matches the requested protocol Annotations @Override

protected UpgradeProtocol getUpgradeProtocol(String name)

Implements abstract org.apache.coyote.AbstractProtocol.getUpgradeProtocol.

Doc from org.apache.coyote.AbstractProtocol.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.

Parameters

name:String: The name of the requested negotiated protocol.

Returns:UpgradeProtocol

The instance where UpgradeProtocol#getAlpnName() matches the requested protocol

Annotations

@Override

setAjpFlush	back to summary
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:boolean The new flush setting

setAjpFlush

back to summary

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:boolean: The new flush setting

setAllowedRequestAttributesPattern	back to summary
public void setAllowedRequestAttributesPattern(String allowedRequestAttributesPattern)

setPacketSize	back to summary
public void setPacketSize(int packetSize)

setRequiredSecret back to summary

setRequiredSecret	back to summary
public void setRequiredSecret(String requiredSecret) Deprecated Replaced by `setSecret(String)`. Will be removed in Tomcat 11 onwards Set the required secret that must be included with every request. Parameters requiredSecret:String The required secret Annotations @Deprecated

public void setRequiredSecret(String requiredSecret)

Deprecated

Replaced by setSecret(String). Will be removed in Tomcat 11 onwards

Set the required secret that must be included with every request.

Parameters

requiredSecret:String: The required secret

Annotations

@Deprecated

setSecret	back to summary
public void setSecret(String secret) Set the secret that must be included with every request. Parameters secret:String The required secret

setSecret

back to summary

public void setSecret(String secret)

Set the secret that must be included with every request.

Parameters

secret:String: The required secret

setSecretRequired	back to summary
public void setSecretRequired(boolean secretRequired)

setTomcatAuthentication	back to summary
public void setTomcatAuthentication(boolean tomcatAuthentication)

setTomcatAuthorization	back to summary
public void setTomcatAuthorization(boolean tomcatAuthorization)

start	back to summary
public void start() throws Exception Overrides org.apache.coyote.AbstractProtocol.start. Implements org.apache.coyote.ProtocolHandler.start. Doc from org.apache.coyote.ProtocolHandler.start. Start the protocol. Annotations @Override Exceptions Exception: If the protocol handler fails to start

start

back to summary

public void start() throws Exception

Overrides org.apache.coyote.AbstractProtocol.start.

Implements org.apache.coyote.ProtocolHandler.start.

Doc from org.apache.coyote.ProtocolHandler.start.

Start the protocol.

Annotations