Tomcat 10.1.19 · org.apache.coyote.http2.Http2Protocol

Modifier and Type	Field and Description
private static final byte[]	ALPN_IDENTIFIER
private static final String	ALPN_NAME
pack-priv static final long	DEFAULT_KEEP_ALIVE_TIMEOUT
pack-priv static final int	DEFAULT_MAX_CONCURRENT_STREAM_EXECUTION
pack-priv static final long	DEFAULT_MAX_CONCURRENT_STREAMS
pack-priv static final int	DEFAULT_OVERHEAD_CONTINUATION_THRESHOLD
pack-priv static final int	DEFAULT_OVERHEAD_COUNT_FACTOR
pack-priv static final int	DEFAULT_OVERHEAD_DATA_THRESHOLD
pack-priv static final int	DEFAULT_OVERHEAD_REDUCTION_FACTOR
pack-priv static final int	DEFAULT_OVERHEAD_RESET_FACTOR
pack-priv static final int	DEFAULT_OVERHEAD_WINDOW_UPDATE_THRESHOLD
pack-priv static final long	DEFAULT_READ_TIMEOUT
pack-priv static final long	DEFAULT_STREAM_READ_TIMEOUT
pack-priv static final long	DEFAULT_STREAM_WRITE_TIMEOUT
pack-priv static final long	DEFAULT_WRITE_TIMEOUT
private RequestGroupInfo	global
private AbstractHttp11Protocol<?>	http11Protocol
private static final String	HTTP_UPGRADE_NAME
private int	initialWindowSize
private boolean	initiatePingDisabled
private long	keepAliveTimeout
private static final Log	log
private int	maxConcurrentStreamExecution
private long	maxConcurrentStreams
private int	maxHeaderCount
private int	maxTrailerCount
private int	overheadContinuationThreshold
private int	overheadCountFactor
private int	overheadDataThreshold
private int	overheadResetFactor
private int	overheadWindowUpdateThreshold
private long	readTimeout
private static final StringManager	sm
private long	streamReadTimeout
private long	streamWriteTimeout
private boolean	useSendfile
private long	writeTimeout

Access	Constructor and Description
public	Http2Protocol()

Method Summary

Modifier and Type	Method and Description
public boolean	accept(Request The request that included an upgrade header for this protocol request) Implements org.apache.coyote.UpgradeProtocol.accept. Allows the implementation to examine the request and accept or reject it based on what it finds.
public byte[]	getAlpnIdentifier() Implements org.apache.coyote.UpgradeProtocol.getAlpnIdentifier.
public String	getAlpnName() Implements org.apache.coyote.UpgradeProtocol.getAlpnName.
public ContinueResponseTiming	getContinueResponseTimingInternal()
public RequestGroupInfo	getGlobal()
public AbstractHttp11Protocol<?>	getHttp11Protocol()
public String	getHttpUpgradeName(boolean Is this for a connector that is configured to support TLS. Some protocols (e.g. HTTP/2) only support HTTP upgrade over non-secure connections. isSSLEnabled) Implements org.apache.coyote.UpgradeProtocol.getHttpUpgradeName.
public int	getInitialWindowSize()
public boolean	getInitiatePingDisabled()
public InternalHttpUpgradeHandler	getInternalUpgradeHandler(SocketWrapperBase<?> The socket socketWrapper, Adapter The Adapter to use to configure the new upgrade handler adapter, Request A copy (may be incomplete) of the request that triggered the upgrade coyoteRequest) Implements org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.
public long	getKeepAliveTimeout()
public int	getMaxConcurrentStreamExecution()
public long	getMaxConcurrentStreams()
public int	getMaxHeaderCount()
public int	getMaxHeaderSize()
public int	getMaxTrailerCount()
public int	getMaxTrailerSize()
public int	getOverheadContinuationThreshold()
public int	getOverheadCountFactor()
public int	getOverheadDataThreshold()
public int	getOverheadResetFactor()
public int	getOverheadWindowUpdateThreshold()
public Processor	getProcessor(SocketWrapperBase<?> The socketWrapper for the connection that requires a processor socketWrapper, Adapter The Adapter instance that provides access to the standard Engine/Host/Context/Wrapper processing chain adapter) Implements org.apache.coyote.UpgradeProtocol.getProcessor.
public long	getReadTimeout()
public long	getStreamReadTimeout()
public long	getStreamWriteTimeout()
public String	getUpgradeProtocolName()
public boolean	getUseSendfile()
public long	getWriteTimeout()
pack-priv boolean	isTrailerHeaderAllowed(String headerName)
public void	setHttp11Protocol(AbstractHttp11Protocol<?> The HTTP/1.1 protocol implementation that will initially handle any connections passed to this UpgradeProtocol via the HTTP upgrade mechanism http11Protocol) Overrides default org.apache.coyote.UpgradeProtocol.setHttp11Protocol. Configure the HTTP/1.1 protocol that this UpgradeProcotol is nested under.
public void	setInitialWindowSize(int initialWindowSize)
public void	setInitiatePingDisabled(boolean initiatePingDisabled)
public void	setKeepAliveTimeout(long keepAliveTimeout)
public void	setMaxConcurrentStreamExecution(int maxConcurrentStreamExecution)
public void	setMaxConcurrentStreams(long maxConcurrentStreams)
public void	setMaxHeaderCount(int maxHeaderCount)
public void	setMaxTrailerCount(int maxTrailerCount)
public void	setOverheadContinuationThreshold(int overheadContinuationThreshold)
public void	setOverheadCountFactor(int overheadCountFactor)
public void	setOverheadDataThreshold(int overheadDataThreshold)
public void	setOverheadResetFactor(int overheadResetFactor)
public void	setOverheadWindowUpdateThreshold(int overheadWindowUpdateThreshold)
public void	setReadTimeout(long readTimeout)
public void	setStreamReadTimeout(long streamReadTimeout)
public void	setStreamWriteTimeout(long streamWriteTimeout)
public void	setUseSendfile(boolean useSendfile)
public void	setWriteTimeout(long writeTimeout)
public boolean	useCompression(Request request, Response response)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALPN_IDENTIFIER	back to summary
private static final byte[] ALPN_IDENTIFIER

ALPN_NAME	back to summary
private static final String ALPN_NAME

DEFAULT_KEEP_ALIVE_TIMEOUT	back to summary
pack-priv static final long DEFAULT_KEEP_ALIVE_TIMEOUT

DEFAULT_MAX_CONCURRENT_STREAM_EXECUTION	back to summary
pack-priv static final int DEFAULT_MAX_CONCURRENT_STREAM_EXECUTION

DEFAULT_MAX_CONCURRENT_STREAMS	back to summary
pack-priv static final long DEFAULT_MAX_CONCURRENT_STREAMS

DEFAULT_OVERHEAD_CONTINUATION_THRESHOLD	back to summary
pack-priv static final int DEFAULT_OVERHEAD_CONTINUATION_THRESHOLD

DEFAULT_OVERHEAD_COUNT_FACTOR	back to summary
pack-priv static final int DEFAULT_OVERHEAD_COUNT_FACTOR

DEFAULT_OVERHEAD_DATA_THRESHOLD	back to summary
pack-priv static final int DEFAULT_OVERHEAD_DATA_THRESHOLD

DEFAULT_OVERHEAD_REDUCTION_FACTOR	back to summary
pack-priv static final int DEFAULT_OVERHEAD_REDUCTION_FACTOR

DEFAULT_OVERHEAD_RESET_FACTOR	back to summary
pack-priv static final int DEFAULT_OVERHEAD_RESET_FACTOR

DEFAULT_OVERHEAD_WINDOW_UPDATE_THRESHOLD	back to summary
pack-priv static final int DEFAULT_OVERHEAD_WINDOW_UPDATE_THRESHOLD

DEFAULT_READ_TIMEOUT	back to summary
pack-priv static final long DEFAULT_READ_TIMEOUT

DEFAULT_STREAM_READ_TIMEOUT	back to summary
pack-priv static final long DEFAULT_STREAM_READ_TIMEOUT

DEFAULT_STREAM_WRITE_TIMEOUT	back to summary
pack-priv static final long DEFAULT_STREAM_WRITE_TIMEOUT

DEFAULT_WRITE_TIMEOUT	back to summary
pack-priv static final long DEFAULT_WRITE_TIMEOUT

global	back to summary
private RequestGroupInfo global

http11Protocol	back to summary
private AbstractHttp11Protocol<?> http11Protocol

HTTP_UPGRADE_NAME	back to summary
private static final String HTTP_UPGRADE_NAME

initialWindowSize	back to summary
private int initialWindowSize

initiatePingDisabled	back to summary
private boolean initiatePingDisabled

keepAliveTimeout	back to summary
private long keepAliveTimeout

log	back to summary
private static final Log log

maxConcurrentStreamExecution	back to summary
private int maxConcurrentStreamExecution

maxConcurrentStreams	back to summary
private long maxConcurrentStreams

maxHeaderCount	back to summary
private int maxHeaderCount

maxTrailerCount	back to summary
private int maxTrailerCount

overheadContinuationThreshold	back to summary
private int overheadContinuationThreshold

overheadCountFactor	back to summary
private int overheadCountFactor

overheadDataThreshold	back to summary
private int overheadDataThreshold

overheadResetFactor	back to summary
private int overheadResetFactor

overheadWindowUpdateThreshold	back to summary
private int overheadWindowUpdateThreshold

readTimeout	back to summary
private long readTimeout

sm	back to summary
private static final StringManager sm

streamReadTimeout	back to summary
private long streamReadTimeout

streamWriteTimeout	back to summary
private long streamWriteTimeout

useSendfile	back to summary
private boolean useSendfile

writeTimeout	back to summary
private long writeTimeout

Constructor Detail

Http2Protocol	back to summary
public Http2Protocol()

Method Detail

accept back to summary

accept	back to summary
public boolean accept(Request request) Implements org.apache.coyote.UpgradeProtocol.accept. Doc from org.apache.coyote.UpgradeProtocol.accept. Allows the implementation to examine the request and accept or reject it based on what it finds. Parameters request:Request The request that included an upgrade header for this protocol Returns:boolean `true` if the request is accepted, otherwise `false` Annotations @Override

public boolean accept(Request request)

Implements org.apache.coyote.UpgradeProtocol.accept.

Doc from org.apache.coyote.UpgradeProtocol.accept.

Allows the implementation to examine the request and accept or reject it based on what it finds.

Parameters

request:Request: The request that included an upgrade header for this protocol

Returns:boolean

true if the request is accepted, otherwise false

Annotations

@Override

getAlpnIdentifier back to summary

getAlpnIdentifier	back to summary
public byte[] getAlpnIdentifier() Implements org.apache.coyote.UpgradeProtocol.getAlpnIdentifier. Returns:byte[] Doc from org.apache.coyote.UpgradeProtocol.getAlpnIdentifier. The byte sequence as listed in the IANA registry for this protocol or `null` if upgrade via ALPN is not supported. Annotations @Override

public byte[] getAlpnIdentifier()

Implements org.apache.coyote.UpgradeProtocol.getAlpnIdentifier.

Returns:byte[]

Doc from org.apache.coyote.UpgradeProtocol.getAlpnIdentifier.

The byte sequence as listed in the IANA registry for this protocol or null if upgrade via ALPN is not supported.

Annotations

@Override

getAlpnName back to summary

getAlpnName	back to summary
public String getAlpnName() Implements org.apache.coyote.UpgradeProtocol.getAlpnName. Returns:String Doc from org.apache.coyote.UpgradeProtocol.getAlpnName. The name of the protocol as listed in the IANA registry if and only if `getAlpnIdentifier()` returns the UTF-8 encoding of this name. If `getAlpnIdentifier()` returns some other byte sequence, then this method returns the empty string. If upgrade via ALPN is not supported then `null` is returned. Annotations @Override

public String getAlpnName()

Implements org.apache.coyote.UpgradeProtocol.getAlpnName.

Returns:String

Doc from org.apache.coyote.UpgradeProtocol.getAlpnName.

The name of the protocol as listed in the IANA registry if and only if getAlpnIdentifier() returns the UTF-8 encoding of this name. If getAlpnIdentifier() returns some other byte sequence, then this method returns the empty string. If upgrade via ALPN is not supported then null is returned.

Annotations

@Override

getContinueResponseTimingInternal	back to summary
public ContinueResponseTiming getContinueResponseTimingInternal()

getGlobal	back to summary
public RequestGroupInfo getGlobal()

getHttp11Protocol	back to summary
public AbstractHttp11Protocol<?> getHttp11Protocol()

getHttpUpgradeName back to summary

getHttpUpgradeName	back to summary
public String getHttpUpgradeName(boolean isSSLEnabled) Implements org.apache.coyote.UpgradeProtocol.getHttpUpgradeName. Parameters isSSLEnabled:boolean Doc from org.apache.coyote.UpgradeProtocol.getHttpUpgradeName. Is this for a connector that is configured to support TLS. Some protocols (e.g. HTTP/2) only support HTTP upgrade over non-secure connections. Returns:String Doc from org.apache.coyote.UpgradeProtocol.getHttpUpgradeName. The name that clients will use to request an upgrade to this protocol via an HTTP/1.1 upgrade request or `null` if upgrade via an HTTP/1.1 upgrade request is not supported. Annotations @Override

public String getHttpUpgradeName(boolean isSSLEnabled)

Implements org.apache.coyote.UpgradeProtocol.getHttpUpgradeName.

Parameters

isSSLEnabled:boolean

Doc from org.apache.coyote.UpgradeProtocol.getHttpUpgradeName.

Is this for a connector that is configured to support TLS. Some protocols (e.g. HTTP/2) only support HTTP upgrade over non-secure connections.

Returns:String

Doc from org.apache.coyote.UpgradeProtocol.getHttpUpgradeName.

The name that clients will use to request an upgrade to this protocol via an HTTP/1.1 upgrade request or null if upgrade via an HTTP/1.1 upgrade request is not supported.

Annotations

@Override

getInitialWindowSize	back to summary
public int getInitialWindowSize()

getInitiatePingDisabled	back to summary
public boolean getInitiatePingDisabled()

getInternalUpgradeHandler

back to summary

public InternalHttpUpgradeHandler getInternalUpgradeHandler(SocketWrapperBase<?> socketWrapper, Adapter adapter, Request coyoteRequest)

Implements org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.

Parameters

socketWrapper:SocketWrapperBase<?>

Doc from org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.

The socket

adapter:Adapter

Doc from org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.

The Adapter to use to configure the new upgrade handler

coyoteRequest:Request

Doc from org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.

A copy (may be incomplete) of the request that triggered the upgrade

Returns:InternalHttpUpgradeHandler

Doc from org.apache.coyote.UpgradeProtocol.getInternalUpgradeHandler.

An instance of the HTTP upgrade handler for this protocol

Annotations

@Override

getKeepAliveTimeout	back to summary
public long getKeepAliveTimeout()

getMaxConcurrentStreamExecution	back to summary
public int getMaxConcurrentStreamExecution()

getMaxConcurrentStreams	back to summary
public long getMaxConcurrentStreams()

getMaxHeaderCount	back to summary
public int getMaxHeaderCount()

getMaxHeaderSize	back to summary
public int getMaxHeaderSize()

getMaxTrailerCount	back to summary
public int getMaxTrailerCount()

getMaxTrailerSize	back to summary
public int getMaxTrailerSize()

getOverheadContinuationThreshold	back to summary
public int getOverheadContinuationThreshold()

getOverheadCountFactor	back to summary
public int getOverheadCountFactor()

getOverheadDataThreshold	back to summary
public int getOverheadDataThreshold()

getOverheadResetFactor	back to summary
public int getOverheadResetFactor()

getOverheadWindowUpdateThreshold	back to summary
public int getOverheadWindowUpdateThreshold()

getProcessor

back to summary

public Processor getProcessor(SocketWrapperBase<?> socketWrapper, Adapter adapter)

Implements org.apache.coyote.UpgradeProtocol.getProcessor.

Parameters

socketWrapper:SocketWrapperBase<?>

Doc from org.apache.coyote.UpgradeProtocol.getProcessor.

The socketWrapper for the connection that requires a processor

adapter:Adapter

Doc from org.apache.coyote.UpgradeProtocol.getProcessor.

The Adapter instance that provides access to the standard Engine/Host/Context/Wrapper processing chain

Returns:Processor

Doc from org.apache.coyote.UpgradeProtocol.getProcessor.

A processor instance for processing a connection using this protocol.

Annotations

@Override

getReadTimeout	back to summary
public long getReadTimeout()

getStreamReadTimeout	back to summary
public long getStreamReadTimeout()

getStreamWriteTimeout	back to summary
public long getStreamWriteTimeout()

getUpgradeProtocolName	back to summary
public String getUpgradeProtocolName()

getUseSendfile	back to summary
public boolean getUseSendfile()

getWriteTimeout	back to summary
public long getWriteTimeout()

isTrailerHeaderAllowed	back to summary
pack-priv boolean isTrailerHeaderAllowed(String headerName)

setHttp11Protocol

back to summary

public void setHttp11Protocol(AbstractHttp11Protocol<?> http11Protocol)

Overrides default org.apache.coyote.UpgradeProtocol.setHttp11Protocol.

Doc from org.apache.coyote.UpgradeProtocol.setHttp11Protocol.

Configure the HTTP/1.1 protocol that this UpgradeProcotol is nested under. Connections passed to this UpgradeProtocol via HTTP upgrade will have been initially handled by this HTTP/1.1 protocol implementation.

The default implementation is a NO-OP.

Parameters

http11Protocol:AbstractHttp11Protocol<?>: The HTTP/1.1 protocol implementation that will initially handle any connections passed to this UpgradeProtocol via the HTTP upgrade mechanism

Annotations

@Override

setInitialWindowSize	back to summary
public void setInitialWindowSize(int initialWindowSize)

setInitiatePingDisabled	back to summary
public void setInitiatePingDisabled(boolean initiatePingDisabled)

setKeepAliveTimeout	back to summary
public void setKeepAliveTimeout(long keepAliveTimeout)

setMaxConcurrentStreamExecution	back to summary
public void setMaxConcurrentStreamExecution(int maxConcurrentStreamExecution)

setMaxConcurrentStreams	back to summary
public void setMaxConcurrentStreams(long maxConcurrentStreams)

setMaxHeaderCount	back to summary
public void setMaxHeaderCount(int maxHeaderCount)

setMaxTrailerCount	back to summary
public void setMaxTrailerCount(int maxTrailerCount)

setOverheadContinuationThreshold	back to summary
public void setOverheadContinuationThreshold(int overheadContinuationThreshold)

setOverheadCountFactor	back to summary
public void setOverheadCountFactor(int overheadCountFactor)

setOverheadDataThreshold	back to summary
public void setOverheadDataThreshold(int overheadDataThreshold)

setOverheadResetFactor	back to summary
public void setOverheadResetFactor(int overheadResetFactor)

setOverheadWindowUpdateThreshold	back to summary
public void setOverheadWindowUpdateThreshold(int overheadWindowUpdateThreshold)

setReadTimeout	back to summary
public void setReadTimeout(long readTimeout)

setStreamReadTimeout	back to summary
public void setStreamReadTimeout(long streamReadTimeout)

setStreamWriteTimeout	back to summary
public void setStreamWriteTimeout(long streamWriteTimeout)

setUseSendfile	back to summary
public void setUseSendfile(boolean useSendfile)

setWriteTimeout	back to summary
public void setWriteTimeout(long writeTimeout)

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

public Class Http2Protocol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail