Class ProxyProtocolClientConnectionFactory.V2.Tag

java.lang.Object

org.eclipse.jetty.client.ProxyProtocolClientConnectionFactory.V2.Tag

All Implemented Interfaces:

org.eclipse.jetty.io.ClientConnectionFactory.Decorator

Enclosing class:

ProxyProtocolClientConnectionFactory.V2

public static class ProxyProtocolClientConnectionFactory.V2.Tag
extends Object
implements org.eclipse.jetty.io.ClientConnectionFactory.Decorator

PROXY protocol version 2 metadata holder to be used in conjunction with Request.tag(Object).

Instances of this class are associated to a destination so that all connections of that destination will initiate the communication with the PROXY protocol version 2 bytes specified by this metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProxyProtocolClientConnectionFactory.V2.Tag.Command
static enum	ProxyProtocolClientConnectionFactory.V2.Tag.Family
static enum	ProxyProtocolClientConnectionFactory.V2.Tag.Protocol
static class	ProxyProtocolClientConnectionFactory.V2.Tag.TLV

Field Summary

Fields

Modifier and Type	Field	Description
static final ProxyProtocolClientConnectionFactory.V2.Tag	LOCAL	The PROXY V2 Tag typically used to "ping" the server.

Fields inherited from interface org.eclipse.jetty.io.ClientConnectionFactory.Decorator

CONTEXT_KEY

Constructor Summary

Constructors

Constructor	Description
Tag()	Creates a Tag whose metadata will be derived from the underlying EndPoint.
Tag(String srcIP, int srcPort)	Creates a Tag with the given source metadata.
Tag(String srcIP, int srcPort, List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV> tlvs)	Creates a Tag with the given source metadata and Type-Length-Value (TLV) objects.
Tag(ProxyProtocolClientConnectionFactory.V2.Tag.Command command, ProxyProtocolClientConnectionFactory.V2.Tag.Family family, ProxyProtocolClientConnectionFactory.V2.Tag.Protocol protocol, String srcIP, int srcPort, String dstIP, int dstPort, List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV> tlvs)	Creates a Tag with the given metadata.

Method Summary

Modifier and Type	Method	Description
org.eclipse.jetty.io.ClientConnectionFactory	apply(org.eclipse.jetty.io.ClientConnectionFactory factory)
boolean	equals(Object obj)
static ProxyProtocolClientConnectionFactory.V2.Tag	from(org.eclipse.jetty.io.EndPoint endPoint, boolean local)	Creates a Tag from the given EndPoint.
ProxyProtocolClientConnectionFactory.V2.Tag.Command	getCommand()
String	getDestinationAddress()
int	getDestinationPort()
ProxyProtocolClientConnectionFactory.V2.Tag.Family	getFamily()
ProxyProtocolClientConnectionFactory.V2.Tag.Protocol	getProtocol()
String	getSourceAddress()
int	getSourcePort()
List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV>	getTLVs()
int	hashCode()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

LOCAL

public static final ProxyProtocolClientConnectionFactory.V2.Tag LOCAL

The PROXY V2 Tag typically used to "ping" the server.

Constructor Details

Tag

public Tag()

Creates a Tag whose metadata will be derived from the underlying EndPoint.

Tag

public Tag(String srcIP,
 int srcPort)

Creates a Tag with the given source metadata.

The destination metadata will be derived from the underlying EndPoint.

Parameters:

srcIP - the source IP address

srcPort - the source port

Tag

public Tag(String srcIP,
 int srcPort,
 List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV> tlvs)

Creates a Tag with the given source metadata and Type-Length-Value (TLV) objects.

The destination metadata will be derived from the underlying EndPoint.

Parameters:

srcIP - the source IP address

srcPort - the source port

tlvs - the TLV objects

Tag

public Tag(ProxyProtocolClientConnectionFactory.V2.Tag.Command command,
 ProxyProtocolClientConnectionFactory.V2.Tag.Family family,
 ProxyProtocolClientConnectionFactory.V2.Tag.Protocol protocol,
 String srcIP,
 int srcPort,
 String dstIP,
 int dstPort,
 List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV> tlvs)

Creates a Tag with the given metadata.

Missing metadata will be derived from the underlying EndPoint.

Parameters:

command - the LOCAL or PROXY command

family - the protocol family

protocol - the protocol type

srcIP - the source IP address

srcPort - the source port

dstIP - the destination IP address

dstPort - the destination port

tlvs - the TLV objects

Method Details

from

public static ProxyProtocolClientConnectionFactory.V2.Tag from(org.eclipse.jetty.io.EndPoint endPoint,
 boolean local)

Creates a Tag from the given EndPoint.

The source parameter indicates whether the EndPoint is the local EndPoint (typical for clients), or the remote EndPoint (typical for proxies). In the latter case, the proxy wants to forward to the server the information about the remote client so the EndPoint must be that connected to the remote client (not to the server).

Parameters:

endPoint - the EndPoint to create the Tag from

local - whether the EndPoint is local or remote

Returns:

a new Tag from the given EndPoint

getCommand

public ProxyProtocolClientConnectionFactory.V2.Tag.Command getCommand()

getFamily

public ProxyProtocolClientConnectionFactory.V2.Tag.Family getFamily()

getProtocol

public ProxyProtocolClientConnectionFactory.V2.Tag.Protocol getProtocol()

getSourceAddress

public String getSourceAddress()

getSourcePort

public int getSourcePort()

getDestinationAddress

public String getDestinationAddress()

getDestinationPort

public int getDestinationPort()

getTLVs

public List<ProxyProtocolClientConnectionFactory.V2.Tag.TLV> getTLVs()

apply

public org.eclipse.jetty.io.ClientConnectionFactory apply(org.eclipse.jetty.io.ClientConnectionFactory factory)

Specified by:

apply in interface org.eclipse.jetty.io.ClientConnectionFactory.Decorator

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object