Tomcat 10.1.19 · org.apache.coyote.UpgradeProtocol · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the request is accepted, otherwise `false` accept(Request The request that included an upgrade header for this protocol request) Allows the implementation to examine the request and accept or reject it based on what it finds.
public byte[]	Returns: The byte sequence as listed in the IANA registry for this protocol or `null` if upgrade via ALPN is not supported. getAlpnIdentifier()
public String	Returns: 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. getAlpnName()
public String	Returns: 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. 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)
public InternalHttpUpgradeHandler	Returns: An instance of the HTTP upgrade handler for this protocol 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 request)
public Processor	Returns: A processor instance for processing a connection using this protocol. 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)
public default void	setHttp11Protocol(AbstractHttp11Protocol<?> The HTTP/1.1 protocol implementation that will initially handle any connections passed to this UpgradeProtocol via the HTTP upgrade mechanism protocol) Configure the HTTP/1.1 protocol that this UpgradeProcotol is nested under.

Method Detail

accept back to summary

accept	back to summary
public boolean accept(Request request) 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`

public boolean accept(Request request)

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

getAlpnIdentifier	back to summary
public byte[] getAlpnIdentifier() Returns:byte[] The byte sequence as listed in the IANA registry for this protocol or `null` if upgrade via ALPN is not supported.

getAlpnName	back to summary
public String getAlpnName() Returns:String 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.

getHttpUpgradeName back to summary

getHttpUpgradeName	back to summary
public String getHttpUpgradeName(boolean isSSLEnabled) Parameters isSSLEnabled: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. Returns:String 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.

public String getHttpUpgradeName(boolean isSSLEnabled)

Parameters

isSSLEnabled: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.

Returns:String

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.

getInternalUpgradeHandler	back to summary
public InternalHttpUpgradeHandler getInternalUpgradeHandler(SocketWrapperBase<?> socketWrapper, Adapter adapter, Request request) Parameters socketWrapper:SocketWrapperBase<?> The socket adapter:Adapter The Adapter to use to configure the new upgrade handler request:Request A copy (may be incomplete) of the request that triggered the upgrade Returns:InternalHttpUpgradeHandler An instance of the HTTP upgrade handler for this protocol

getInternalUpgradeHandler

back to summary

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

Parameters

socketWrapper:SocketWrapperBase<?>: The socket
adapter:Adapter: The Adapter to use to configure the new upgrade handler
request:Request: A copy (may be incomplete) of the request that triggered the upgrade

Returns:InternalHttpUpgradeHandler

An instance of the HTTP upgrade handler for this protocol

getProcessor	back to summary
public Processor getProcessor(SocketWrapperBase<?> socketWrapper, Adapter adapter) Parameters socketWrapper:SocketWrapperBase<?> The socketWrapper for the connection that requires a processor adapter:Adapter The Adapter instance that provides access to the standard Engine/Host/Context/Wrapper processing chain Returns:Processor A processor instance for processing a connection using this protocol.

getProcessor

back to summary

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

Parameters

socketWrapper:SocketWrapperBase<?>: The socketWrapper for the connection that requires a processor
adapter:Adapter: The Adapter instance that provides access to the standard Engine/Host/Context/Wrapper processing chain

Returns:Processor

A processor instance for processing a connection using this protocol.

setHttp11Protocol	back to summary
public default void setHttp11Protocol(AbstractHttp11Protocol<?> protocol) 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 protocol:AbstractHttp11Protocol<?> The HTTP/1.1 protocol implementation that will initially handle any connections passed to this UpgradeProtocol via the HTTP upgrade mechanism

setHttp11Protocol

back to summary

public default void setHttp11Protocol(AbstractHttp11Protocol<?> protocol)

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

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

public Interface UpgradeProtocol

Method Summary

Method Detail