Tomcat 10.1.19 · org.apache.coyote.http11.AbstractHttp11Protocol

Modifier and Type	Field and Description
private Set<String>	allowedTrailerHeaders The names of headers that are allowed to be sent via a trailer when using chunked encoding.
private boolean	allowHostHeaderMismatch
private final CompressionConfig	compressionConfig
private int	connectionUploadTimeout
private ContinueResponseTiming	continueResponseTiming
private boolean	disableUploadTimeout
private final Map<String, UpgradeProtocol>	httpUpgradeProtocols The protocols that are available via internal Tomcat support for access via HTTP upgrade.
private int	maxExtensionSize Maximum size of extension information in chunked encoding
private int	maxHttpHeaderSize Maximum size of the HTTP message header.
private int	maxHttpRequestHeaderSize Maximum size of the HTTP request message header.
private int	maxHttpResponseHeaderSize Maximum size of the HTTP response message header.
private int	maxSavePostSize
private int	maxSwallowSize Maximum amount of request body to swallow.
private int	maxTrailerSize Maximum size of trailing headers in bytes
private final Map<String, UpgradeProtocol>	negotiatedProtocols The protocols that are available via internal Tomcat support for access via ALPN negotiation.
private boolean	rejectIllegalHeader
private String	relaxedPathChars
private String	relaxedQueryChars
private Pattern	restrictedUserAgents
private boolean	secure This field indicates if the protocol is treated as if it is secure.
private String	server
private boolean	serverRemoveAppProvidedValues
protected static final StringManager	sm Hides org.apache.coyote.AbstractProtocol.sm.
private final Map<String, UpgradeGroupInfo>	upgradeProtocolGroupInfos Map of upgrade protocol name to `UpgradeGroupInfo` instance.
private final List<UpgradeProtocol>	upgradeProtocols The upgrade protocol instances configured.
private boolean	useKeepAliveResponseHeader

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

Method Summary

Modifier and Type	Method and Description
public void	addAllowedTrailerHeader(String header)
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.
private void	configureUpgradeProtocol(UpgradeProtocol upgradeProtocol)
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 void	destroy() Overrides org.apache.coyote.AbstractProtocol.destroy. Implements org.apache.coyote.ProtocolHandler.destroy. Destroy the protocol (optional).
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 String	getAllowedTrailerHeaders()
protected Set<String>	getAllowedTrailerHeadersInternal()
public boolean	Returns: `true` if Tomcat will allow such requests, otherwise `false` getAllowHostHeaderMismatch() Deprecated This will removed in Tomcat 11 onwards where `allowHostHeaderMismatch` will be hard-coded to `false`. Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?
public String	getCompressibleMimeType()
public String[]	getCompressibleMimeTypes()
public String	getCompression()
protected int	getCompressionLevel()
public int	getCompressionMinSize()
public int	Returns: The timeout in milliseconds getConnectionUploadTimeout() Specifies a different (usually longer) connection timeout during data upload.
public String	getContinueResponseTiming()
public ContinueResponseTiming	getContinueResponseTimingInternal()
public String	getDefaultSSLHostConfigName()
public boolean	Returns: `true` if the separate upload timeout is disabled getDisableUploadTimeout() Get the flag that controls upload time-outs.
protected AbstractEndpoint<S, ?>	getEndpoint() Overrides org.apache.coyote.AbstractProtocol.getEndpoint. Over-ridden here to make the method visible to nested classes.
public int	getMaxExtensionSize()
public int	getMaxHttpHeaderSize()
public int	getMaxHttpRequestHeaderSize()
public int	getMaxHttpResponseHeaderSize()
public int	Returns: The maximum number of requests which can be performed over a keep-alive connection. The default is the same as for Apache HTTP Server (100). getMaxKeepAliveRequests()
public int	Returns: The size in bytes getMaxSavePostSize() Return the maximum size of the post which will be saved during FORM or CLIENT-CERT authentication.
public int	getMaxSwallowSize()
public int	getMaxTrailerSize()
public UpgradeProtocol	getNegotiatedProtocol(String The name of the requested negotiated protocol. negotiatedName) Implements abstract org.apache.coyote.AbstractProtocol.getNegotiatedProtocol. Find a suitable handler for the protocol negotiated at the network layer.
public String	getNoCompressionUserAgents()
protected Pattern	getNoCompressionUserAgentsPattern()
public ObjectName	getONameForUpgrade(String upgradeProtocol)
protected String	getProtocolName() Implements abstract org.apache.coyote.AbstractProtocol.getProtocolName. Obtain the name of the protocol, (Http, Ajp, etc.).
public boolean	Returns: `true` if the request will be rejected or `false` if the header will be ignored getRejectIllegalHeader() Deprecated This will removed in Tomcat 11 onwards where `allowHostHeaderMismatch` will be hard-coded to `true`. If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) will the request be rejected (with a 400 response) or will the illegal header be ignored?
public String	getRelaxedPathChars()
public String	getRelaxedQueryChars()
public String	Returns: The regular expression as a String getRestrictedUserAgents() Get the string form of the regular expression that defines the User agents which should be restricted to HTTP/1.0 support.
protected Pattern	getRestrictedUserAgentsPattern()
public boolean	getSecure()
public String	getServer()
public boolean	Returns: `true` if application provided values should be removed, otherwise `false` getServerRemoveAppProvidedValues() Should application provider values for the HTTP Server header be removed.
public UpgradeGroupInfo	getUpgradeGroupInfo(String upgradeProtocol)
public UpgradeProtocol	getUpgradeProtocol(String The name of the requested negotiated protocol. upgradedName) Implements abstract org.apache.coyote.AbstractProtocol.getUpgradeProtocol. Find a suitable handler for the protocol upgraded name specified.
public boolean	getUseKeepAliveResponseHeader()
public boolean	getUseSendfile()
public void	init() Overrides org.apache.coyote.AbstractProtocol.init. Implements org.apache.coyote.ProtocolHandler.init. Initialise the protocol.
public boolean	isSSLEnabled()
public boolean	isTrailerHeaderAllowed(String headerName)
public void	reloadSslHostConfig(String hostName)
public void	reloadSslHostConfigs()
public void	removeAllowedTrailerHeader(String header)
public void	setAllowedTrailerHeaders(String commaSeparatedHeaders)
public void	setAllowHostHeaderMismatch(boolean `true` to allow such requests, `false` to reject them with a 400 allowHostHeaderMismatch) Deprecated This will removed in Tomcat 11 onwards where `allowHostHeaderMismatch` will be hard-coded to `false`. Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?
public void	setCompressibleMimeType(String valueS)
public void	setCompression(String compression)
public void	setCompressionMinSize(int compressionMinSize)
public void	setConnectionUploadTimeout(int Upload timeout in milliseconds timeout) Set the upload timeout.
public void	setContinueResponseTiming(String continueResponseTiming)
public void	setDefaultSSLHostConfigName(String defaultSSLHostConfigName)
public void	setDisableUploadTimeout(boolean `true` if the separate upload timeout should be disabled isDisabled) Set the flag to control whether a separate connection timeout is used during upload of a request body.
public void	setMaxExtensionSize(int maxExtensionSize)
public void	setMaxHttpHeaderSize(int valueI)
public void	setMaxHttpRequestHeaderSize(int valueI)
public void	setMaxHttpResponseHeaderSize(int valueI)
public void	setMaxKeepAliveRequests(int The new maximum number of Keep-Alive requests allowed mkar) Set the maximum number of Keep-Alive requests to allow.
public void	setMaxSavePostSize(int The maximum size POST body to buffer in bytes maxSavePostSize) Set the maximum size of a POST which will be buffered during FORM or CLIENT-CERT authentication.
public void	setMaxSwallowSize(int maxSwallowSize)
public void	setMaxTrailerSize(int maxTrailerSize)
public void	setNoCompressionUserAgents(String noCompressionUserAgents)
public void	setRejectIllegalHeader(boolean `true` to reject requests with illegal header names or values, `false` to ignore the header rejectIllegalHeader) Deprecated This will removed in Tomcat 11 onwards where `allowHostHeaderMismatch` will be hard-coded to `true`. If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) should the request be rejected (with a 400 response) or should the illegal header be ignored?
public void	setRelaxedPathChars(String relaxedPathChars)
public void	setRelaxedQueryChars(String relaxedQueryChars)
public void	setRestrictedUserAgents(String The regular expression as supported by `Pattern` for the user agents e.g. "gorilla\|desesplorer\|tigrus" restrictedUserAgents) Set restricted user agent list (which will downgrade the connector to HTTP/1.0 mode).
public void	setSecure(boolean b)
public void	setServer(String The new value to use for the server header server) Set the server header name.
public void	setServerRemoveAppProvidedValues(boolean serverRemoveAppProvidedValues)
public void	setSSLEnabled(boolean SSLEnabled)
public void	setUseKeepAliveResponseHeader(boolean useKeepAliveResponseHeader)
public void	setUseSendfile(boolean useSendfile)
public boolean	useCompression(Request request, Response response)

Inherited from org.apache.coyote.AbstractProtocol:: addWaitingProcessor awaitConnectionsClose closeServerSocketGraceful 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 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 start startAsyncTimeout stop stopAsyncTimeout

allowedTrailerHeaders	back to summary
private Set<String> allowedTrailerHeaders The names of headers that are allowed to be sent via a trailer when using chunked encoding. They are stored in lower case.

allowHostHeaderMismatch	back to summary
private boolean allowHostHeaderMismatch

compressionConfig	back to summary
private final CompressionConfig compressionConfig

connectionUploadTimeout	back to summary
private int connectionUploadTimeout

continueResponseTiming	back to summary
private ContinueResponseTiming continueResponseTiming

disableUploadTimeout	back to summary
private boolean disableUploadTimeout

httpUpgradeProtocols	back to summary
private final Map<String, UpgradeProtocol> httpUpgradeProtocols The protocols that are available via internal Tomcat support for access via HTTP upgrade.

maxExtensionSize	back to summary
private int maxExtensionSize Maximum size of extension information in chunked encoding

maxHttpHeaderSize	back to summary
private int maxHttpHeaderSize Maximum size of the HTTP message header.

maxHttpRequestHeaderSize	back to summary
private int maxHttpRequestHeaderSize Maximum size of the HTTP request message header.

maxHttpResponseHeaderSize	back to summary
private int maxHttpResponseHeaderSize Maximum size of the HTTP response message header.

maxSavePostSize	back to summary
private int maxSavePostSize

maxSwallowSize	back to summary
private int maxSwallowSize Maximum amount of request body to swallow.

maxTrailerSize	back to summary
private int maxTrailerSize Maximum size of trailing headers in bytes

negotiatedProtocols	back to summary
private final Map<String, UpgradeProtocol> negotiatedProtocols The protocols that are available via internal Tomcat support for access via ALPN negotiation.

rejectIllegalHeader	back to summary
private boolean rejectIllegalHeader

relaxedPathChars	back to summary
private String relaxedPathChars

relaxedQueryChars	back to summary
private String relaxedQueryChars

restrictedUserAgents	back to summary
private Pattern restrictedUserAgents

secure	back to summary
private boolean secure This field indicates if the protocol is treated as if it is secure. This normally means https is being used but can be used to fake https e.g behind a reverse proxy.

server	back to summary
private String server

serverRemoveAppProvidedValues	back to summary
private boolean serverRemoveAppProvidedValues

sm	back to summary
protected static final StringManager sm Hides org.apache.coyote.AbstractProtocol.sm.

upgradeProtocolGroupInfos	back to summary
private final Map<String, UpgradeGroupInfo> upgradeProtocolGroupInfos Map of upgrade protocol name to `UpgradeGroupInfo` instance. HTTP upgrades via `HttpServletRequest#upgrade(Class)` do not have to depend on an `UpgradeProtocol`. To enable basic statistics to be made available for these protocols, a map of protocol name to `UpgradeGroupInfo` instances is maintained here.

upgradeProtocols	back to summary
private final List<UpgradeProtocol> upgradeProtocols The upgrade protocol instances configured.

useKeepAliveResponseHeader	back to summary
private boolean useKeepAliveResponseHeader

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

Method Detail

addAllowedTrailerHeader	back to summary
public void addAllowedTrailerHeader(String header)

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

configureUpgradeProtocol	back to summary
private void configureUpgradeProtocol(UpgradeProtocol upgradeProtocol)

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

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

destroy

back to summary

public void destroy() throws Exception

Overrides org.apache.coyote.AbstractProtocol.destroy.

Implements org.apache.coyote.ProtocolHandler.destroy.

Doc from org.apache.coyote.ProtocolHandler.destroy.

Destroy the protocol (optional).

Annotations

@Override

Exceptions

Exception:: If the protocol handler fails to destroy

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

getAllowedTrailerHeaders	back to summary
public String getAllowedTrailerHeaders()

getAllowedTrailerHeadersInternal	back to summary
protected Set<String> getAllowedTrailerHeadersInternal()

getAllowHostHeaderMismatch back to summary

getAllowHostHeaderMismatch	back to summary
public boolean getAllowHostHeaderMismatch() Deprecated This will removed in Tomcat 11 onwards where `allowHostHeaderMismatch` will be hard-coded to `false`. Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line? Returns:boolean `true` if Tomcat will allow such requests, otherwise `false` Annotations @Deprecated

public boolean getAllowHostHeaderMismatch()

Deprecated

This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to false.

Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?

Returns:boolean

true if Tomcat will allow such requests, otherwise false

Annotations

@Deprecated

getCompressibleMimeType	back to summary
public String getCompressibleMimeType()

getCompressibleMimeTypes	back to summary
public String[] getCompressibleMimeTypes()

getCompression	back to summary
public String getCompression()

getCompressionLevel	back to summary
protected int getCompressionLevel()

getCompressionMinSize	back to summary
public int getCompressionMinSize()

getConnectionUploadTimeout	back to summary
public int getConnectionUploadTimeout() Specifies a different (usually longer) connection timeout during data upload. Default is 5 minutes as in Apache HTTPD server. Returns:int The timeout in milliseconds

getConnectionUploadTimeout

back to summary

public int getConnectionUploadTimeout()

Specifies a different (usually longer) connection timeout during data upload. Default is 5 minutes as in Apache HTTPD server.

Returns:int: The timeout in milliseconds

getContinueResponseTiming	back to summary
public String getContinueResponseTiming()

getContinueResponseTimingInternal	back to summary
public ContinueResponseTiming getContinueResponseTimingInternal()

getDefaultSSLHostConfigName	back to summary
public String getDefaultSSLHostConfigName()

getDisableUploadTimeout back to summary

public boolean getDisableUploadTimeout()

Get the flag that controls upload time-outs. If true, the connectionUploadTimeout will be ignored and the regular socket timeout will be used for the full duration of the connection.

Returns:boolean: true if the separate upload timeout is disabled

getEndpoint

back to summary

protected AbstractEndpoint<S, ?> getEndpoint()

Overrides org.apache.coyote.AbstractProtocol.getEndpoint.

Over-ridden here to make the method visible to nested classes.

Annotations

@Override

getMaxExtensionSize	back to summary
public int getMaxExtensionSize()

getMaxHttpHeaderSize	back to summary
public int getMaxHttpHeaderSize()

getMaxHttpRequestHeaderSize	back to summary
public int getMaxHttpRequestHeaderSize()

getMaxHttpResponseHeaderSize	back to summary
public int getMaxHttpResponseHeaderSize()

getMaxKeepAliveRequests	back to summary
public int getMaxKeepAliveRequests() Returns:int The maximum number of requests which can be performed over a keep-alive connection. The default is the same as for Apache HTTP Server (100).

getMaxSavePostSize

back to summary

public int getMaxSavePostSize()

Return the maximum size of the post which will be saved during FORM or CLIENT-CERT authentication.

Returns:int: The size in bytes

getMaxSwallowSize	back to summary
public int getMaxSwallowSize()

getMaxTrailerSize	back to summary
public int getMaxTrailerSize()

getNegotiatedProtocol back to summary

public UpgradeProtocol getNegotiatedProtocol(String negotiatedName)

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.

Parameters

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

Returns:UpgradeProtocol

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

Annotations

@Override

getNoCompressionUserAgents	back to summary
public String getNoCompressionUserAgents()

getNoCompressionUserAgentsPattern	back to summary
protected Pattern getNoCompressionUserAgentsPattern()

getONameForUpgrade	back to summary
public ObjectName getONameForUpgrade(String upgradeProtocol)

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

getRejectIllegalHeader back to summary

public boolean getRejectIllegalHeader()

Deprecated

This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to true.

If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) will the request be rejected (with a 400 response) or will the illegal header be ignored?

Returns:boolean

true if the request will be rejected or false if the header will be ignored

Annotations

@Deprecated

getRelaxedPathChars	back to summary
public String getRelaxedPathChars()

getRelaxedQueryChars	back to summary
public String getRelaxedQueryChars()

getRestrictedUserAgents

back to summary

public String getRestrictedUserAgents()

Get the string form of the regular expression that defines the User agents which should be restricted to HTTP/1.0 support.

Returns:String: The regular expression as a String

getRestrictedUserAgentsPattern	back to summary
protected Pattern getRestrictedUserAgentsPattern()

getSecure	back to summary
public boolean getSecure()

getServer	back to summary
public String getServer()

getServerRemoveAppProvidedValues back to summary

public boolean getServerRemoveAppProvidedValues()

Should application provider values for the HTTP Server header be removed. Note that if server is set, any application provided value will be over-ridden.

Returns:boolean: true if application provided values should be removed, otherwise false

getUpgradeGroupInfo	back to summary
public UpgradeGroupInfo getUpgradeGroupInfo(String upgradeProtocol)

getUpgradeProtocol back to summary

public UpgradeProtocol getUpgradeProtocol(String upgradedName)

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.

Parameters

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

Returns:UpgradeProtocol

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

Annotations

@Override

getUseKeepAliveResponseHeader	back to summary
public boolean getUseKeepAliveResponseHeader()

getUseSendfile	back to summary
public boolean getUseSendfile()

init

back to summary

public void init() throws Exception

Overrides org.apache.coyote.AbstractProtocol.init.

Implements org.apache.coyote.ProtocolHandler.init.

Doc from org.apache.coyote.ProtocolHandler.init.

Initialise the protocol.

Annotations

@Override

Exceptions

Exception:: If the protocol handler fails to initialise

isSSLEnabled	back to summary
public boolean isSSLEnabled()

isTrailerHeaderAllowed	back to summary
public boolean isTrailerHeaderAllowed(String headerName)

reloadSslHostConfig	back to summary
public void reloadSslHostConfig(String hostName)

reloadSslHostConfigs	back to summary
public void reloadSslHostConfigs()

removeAllowedTrailerHeader	back to summary
public void removeAllowedTrailerHeader(String header)

setAllowedTrailerHeaders	back to summary
public void setAllowedTrailerHeaders(String commaSeparatedHeaders)

setAllowHostHeaderMismatch back to summary

public void setAllowHostHeaderMismatch(boolean allowHostHeaderMismatch)

Deprecated

This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to false.

Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?

Parameters

allowHostHeaderMismatch:boolean: true to allow such requests, false to reject them with a 400

Annotations

@Deprecated

setCompressibleMimeType	back to summary
public void setCompressibleMimeType(String valueS)

setCompression	back to summary
public void setCompression(String compression)

setCompressionMinSize	back to summary
public void setCompressionMinSize(int compressionMinSize)

setConnectionUploadTimeout

back to summary

public void setConnectionUploadTimeout(int timeout)

Set the upload timeout.

Parameters

timeout:int: Upload timeout in milliseconds

setContinueResponseTiming	back to summary
public void setContinueResponseTiming(String continueResponseTiming)

setDefaultSSLHostConfigName	back to summary
public void setDefaultSSLHostConfigName(String defaultSSLHostConfigName)

setDisableUploadTimeout back to summary

public void setDisableUploadTimeout(boolean isDisabled)

Set the flag to control whether a separate connection timeout is used during upload of a request body.

Parameters

isDisabled:boolean: true if the separate upload timeout should be disabled

setMaxExtensionSize	back to summary
public void setMaxExtensionSize(int maxExtensionSize)

setMaxHttpHeaderSize	back to summary
public void setMaxHttpHeaderSize(int valueI)

setMaxHttpRequestHeaderSize	back to summary
public void setMaxHttpRequestHeaderSize(int valueI)

setMaxHttpResponseHeaderSize	back to summary
public void setMaxHttpResponseHeaderSize(int valueI)

setMaxKeepAliveRequests

back to summary

public void setMaxKeepAliveRequests(int mkar)

Set the maximum number of Keep-Alive requests to allow. This is to safeguard from DoS attacks. Setting to a negative value disables the limit.

Parameters

mkar:int: The new maximum number of Keep-Alive requests allowed

setMaxSavePostSize

back to summary

public void setMaxSavePostSize(int maxSavePostSize)

Set the maximum size of a POST which will be buffered during FORM or CLIENT-CERT authentication. When a POST is received where the security constraints require a client certificate, the POST body needs to be buffered while an SSL handshake takes place to obtain the certificate. A similar buffering is required during FORM auth.

Parameters

maxSavePostSize:int: The maximum size POST body to buffer in bytes

setMaxSwallowSize	back to summary
public void setMaxSwallowSize(int maxSwallowSize)

setMaxTrailerSize	back to summary
public void setMaxTrailerSize(int maxTrailerSize)

setNoCompressionUserAgents	back to summary
public void setNoCompressionUserAgents(String noCompressionUserAgents)

setRejectIllegalHeader back to summary

public void setRejectIllegalHeader(boolean rejectIllegalHeader)

Deprecated

This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to true.

If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) should the request be rejected (with a 400 response) or should the illegal header be ignored?

Parameters

rejectIllegalHeader:boolean: true to reject requests with illegal header names or values, false to ignore the header

Annotations

@Deprecated

setRelaxedPathChars	back to summary
public void setRelaxedPathChars(String relaxedPathChars)

setRelaxedQueryChars	back to summary
public void setRelaxedQueryChars(String relaxedQueryChars)

setRestrictedUserAgents back to summary

public void setRestrictedUserAgents(String restrictedUserAgents)

Set restricted user agent list (which will downgrade the connector to HTTP/1.0 mode). Regular expression as supported by Pattern.

Parameters

restrictedUserAgents:String: The regular expression as supported by Pattern for the user agents e.g. "gorilla|desesplorer|tigrus"

setSecure	back to summary
public void setSecure(boolean b)

setServer

back to summary

public void setServer(String server)

Set the server header name.

Parameters

server:String: The new value to use for the server header

setServerRemoveAppProvidedValues	back to summary
public void setServerRemoveAppProvidedValues(boolean serverRemoveAppProvidedValues)

setSSLEnabled	back to summary
public void setSSLEnabled(boolean SSLEnabled)

setUseKeepAliveResponseHeader	back to summary
public void setUseKeepAliveResponseHeader(boolean useKeepAliveResponseHeader)

setUseSendfile	back to summary
public void setUseSendfile(boolean useSendfile)

useCompression	back to summary
public boolean useCompression(Request request, Response response)

public abstract Class AbstractHttp11Protocol<S>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail