Module io.helidon.webserver

Package io.helidon.webserver

Interface ProxyProtocolV2Data

All Superinterfaces:

ProxyProtocolData

public interface ProxyProtocolV2Data
extends ProxyProtocolData

Binary (V2) Proxy protocol data parsed by ProxyProtocolHandler. This is a specialization of the ProxyProtocolData interface. The object returned from ServerRequest.proxyProtocolData() will additionally implement this interface when the proxy version used is the V2 (binary) version.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ProxyProtocolV2Data.Command	The proxy command.
static interface	ProxyProtocolV2Data.Tlv	A Tag-Length-Value vector.

Nested classes/interfaces inherited from interface io.helidon.webserver.ProxyProtocolData

ProxyProtocolData.Family, ProxyProtocolData.Protocol

Method Summary

Modifier and Type	Method	Description
ProxyProtocolV2Data.Command	command()	The command kind, indicating whether the connection was established on purpose by the proxy without being relayed (LOCAL) or on behalf of another relayed node (PROXY).
SocketAddress	destSocketAddress()	The destination address, which may be either an InetSocketAddress or a UnixDomainSocketAddress.
SocketAddress	sourceSocketAddress()	The source address, which may be either an InetSocketAddress or a UnixDomainSocketAddress.
List<ProxyProtocolV2Data.Tlv>	tlvs()	The possibly-empty list of additional Tag-Length-Value vectors included in the proxy header.

Methods inherited from interface io.helidon.webserver.ProxyProtocolData

destAddress, destPort, family, protocol, sourceAddress, sourcePort

Method Details

command

ProxyProtocolV2Data.Command command()

The command kind, indicating whether the connection was established on purpose by the proxy without being relayed (LOCAL) or on behalf of another relayed node (PROXY).

Returns:

The command.

sourceSocketAddress

SocketAddress sourceSocketAddress()

The source address, which may be either an InetSocketAddress or a UnixDomainSocketAddress. If the address family is ProxyProtocolData.Family.UNKNOWN, then this will contain an InetSocketAddress with the contents "0.0.0.0:0".

Returns:

The source socket address.

destSocketAddress

SocketAddress destSocketAddress()

The destination address, which may be either an InetSocketAddress or a UnixDomainSocketAddress. If the address family is ProxyProtocolData.Family.UNKNOWN, then this will contain an InetSocketAddress with the contents "0.0.0.0:0".

Returns:

The destination socket address.

tlvs

List<ProxyProtocolV2Data.Tlv> tlvs()

The possibly-empty list of additional Tag-Length-Value vectors included in the proxy header.

Returns:

A never-null list of Tag-Length-Value data.