Class HAProxyMessage

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.haproxy.HAProxyMessage

All Implemented Interfaces:

ReferenceCounted

public final class HAProxyMessage
extends AbstractReferenceCounted

Message container for decoded HAProxy proxy protocol parameters

Field Summary

Fields

Modifier and Type	Field	Description
private final HAProxyCommand	command
private final String	destinationAddress
private final int	destinationPort
private final ResourceLeakTracker<HAProxyMessage>	leak
private static final ResourceLeakDetector<HAProxyMessage>	leakDetector
private static final int	MAX_NESTING_LEVEL
private final HAProxyProtocolVersion	protocolVersion
private final HAProxyProxiedProtocol	proxiedProtocol
private final String	sourceAddress
private final int	sourcePort
private final List<HAProxyTLV>	tlvs

Constructor Summary

Constructors

Modifier	Constructor	Description
	HAProxyMessage(HAProxyProtocolVersion protocolVersion, HAProxyCommand command, HAProxyProxiedProtocol proxiedProtocol, String sourceAddress, String destinationAddress, int sourcePort, int destinationPort)	Creates a new instance of HAProxyMessage.
	HAProxyMessage(HAProxyProtocolVersion protocolVersion, HAProxyCommand command, HAProxyProxiedProtocol proxiedProtocol, String sourceAddress, String destinationAddress, int sourcePort, int destinationPort, List<? extends HAProxyTLV> tlvs)	Creates a new instance of HAProxyMessage.
private	HAProxyMessage(HAProxyProtocolVersion protocolVersion, HAProxyCommand command, HAProxyProxiedProtocol proxiedProtocol, String sourceAddress, String destinationAddress, String sourcePort, String destinationPort)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
private static void	checkAddress(String address, HAProxyProxiedProtocol.AddressFamily addrFamily)	Validate an address (IPv4, IPv6, Unix Socket)
private static void	checkPort(int port, HAProxyProxiedProtocol.AddressFamily addrFamily)	Validate the port depending on the addrFamily.
HAProxyCommand	command()	Returns the HAProxyCommand of this HAProxyMessage.
protected void	deallocate()	Called once AbstractReferenceCounted.refCnt() is equals 0.
(package private) static HAProxyMessage	decodeHeader(ByteBuf header)	Decodes a version 2, binary proxy protocol header.
(package private) static HAProxyMessage	decodeHeader(String header)	Decodes a version 1, human-readable proxy protocol header.
String	destinationAddress()	Returns the human-readable destination address of this HAProxyMessage.
int	destinationPort()	Returns the UDP/TCP destination port of this HAProxyMessage.
private static String	ipBytesToString(ByteBuf header, int addressLen)	Convert ip address bytes to string representation
private static int	portStringToInt(String value)	Convert port to integer
HAProxyProtocolVersion	protocolVersion()	Returns the HAProxyProtocolVersion of this HAProxyMessage.
HAProxyProxiedProtocol	proxiedProtocol()	Returns the HAProxyProxiedProtocol of this HAProxyMessage.
private static HAProxyTLV	readNextTLV(ByteBuf header, int nestingLevel)
private static List<HAProxyTLV>	readTlvs(ByteBuf header)
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
HAProxyMessage	retain()	Increases the reference count by 1.
HAProxyMessage	retain(int increment)	Increases the reference count by the specified increment.
String	sourceAddress()	Returns the human-readable source address of this HAProxyMessage or null if HAProxy performs health check with send-proxy-v2.
int	sourcePort()	Returns the UDP/TCP source port of this HAProxyMessage.
(package private) int	tlvNumBytes()
List<HAProxyTLV>	tlvs()	Returns a list of HAProxyTLV or an empty list if no TLVs are present.
String	toString()
HAProxyMessage	touch()	Records the current access location of this object for debugging purposes.
HAProxyMessage	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
private void	tryRecord()
private static HAProxyMessage	unknownMsg(HAProxyProtocolVersion version, HAProxyCommand command)	Proxy protocol message for 'UNKNOWN' proxied protocols.

Methods inherited from class AbstractReferenceCounted

refCnt, setRefCnt

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MAX_NESTING_LEVEL

private static final int MAX_NESTING_LEVEL

See Also:

• Constant Field Values

leakDetector

private static final ResourceLeakDetector<HAProxyMessage> leakDetector

leak

private final ResourceLeakTracker<HAProxyMessage> leak

protocolVersion

private final HAProxyProtocolVersion protocolVersion

command

private final HAProxyCommand command

proxiedProtocol

private final HAProxyProxiedProtocol proxiedProtocol

sourceAddress

private final String sourceAddress

destinationAddress

private final String destinationAddress

sourcePort

private final int sourcePort

destinationPort

private final int destinationPort

tlvs

private final List<HAProxyTLV> tlvs

Constructor Details

HAProxyMessage

private HAProxyMessage(HAProxyProtocolVersion protocolVersion,
 HAProxyCommand command,
 HAProxyProxiedProtocol proxiedProtocol,
 String sourceAddress,
 String destinationAddress,
 String sourcePort,
 String destinationPort)

Creates a new instance

HAProxyMessage

public HAProxyMessage(HAProxyProtocolVersion protocolVersion,
 HAProxyCommand command,
 HAProxyProxiedProtocol proxiedProtocol,
 String sourceAddress,
 String destinationAddress,
 int sourcePort,
 int destinationPort)

Creates a new instance of HAProxyMessage.

Parameters:

protocolVersion - the protocol version.

command - the command.

proxiedProtocol - the protocol containing the address family and transport protocol.

sourceAddress - the source address.

destinationAddress - the destination address.

sourcePort - the source port. This value must be 0 for unix, unspec addresses.

destinationPort - the destination port. This value must be 0 for unix, unspec addresses.

HAProxyMessage

public HAProxyMessage(HAProxyProtocolVersion protocolVersion,
 HAProxyCommand command,
 HAProxyProxiedProtocol proxiedProtocol,
 String sourceAddress,
 String destinationAddress,
 int sourcePort,
 int destinationPort,
 List<? extends HAProxyTLV> tlvs)

Creates a new instance of HAProxyMessage.

Parameters:

protocolVersion - the protocol version.

command - the command.

proxiedProtocol - the protocol containing the address family and transport protocol.

sourceAddress - the source address.

destinationAddress - the destination address.

sourcePort - the source port. This value must be 0 for unix, unspec addresses.

destinationPort - the destination port. This value must be 0 for unix, unspec addresses.

tlvs - the list of tlvs.

Method Details

decodeHeader

static HAProxyMessage decodeHeader(ByteBuf header)

Decodes a version 2, binary proxy protocol header.

Parameters:

header - a version 2 proxy protocol header

Returns:

HAProxyMessage instance

Throws:

HAProxyProtocolException - if any portion of the header is invalid

readTlvs

private static List<HAProxyTLV> readTlvs(ByteBuf header)

readNextTLV

private static HAProxyTLV readNextTLV(ByteBuf header,
 int nestingLevel)

decodeHeader

static HAProxyMessage decodeHeader(String header)

Decodes a version 1, human-readable proxy protocol header.

Parameters:

header - a version 1 proxy protocol header

Returns:

HAProxyMessage instance

Throws:

HAProxyProtocolException - if any portion of the header is invalid

unknownMsg

private static HAProxyMessage unknownMsg(HAProxyProtocolVersion version,
 HAProxyCommand command)

Proxy protocol message for 'UNKNOWN' proxied protocols. Per spec, when the proxied protocol is 'UNKNOWN' we must discard all other header values.

ipBytesToString

private static String ipBytesToString(ByteBuf header,
 int addressLen)

Convert ip address bytes to string representation

Parameters:

header - buffer containing ip address bytes

addressLen - number of bytes to read (4 bytes for IPv4, 16 bytes for IPv6)

Returns:

string representation of the ip address

portStringToInt

private static int portStringToInt(String value)

Convert port to integer

Parameters:

value - the port

Returns:

port as an integer

Throws:

IllegalArgumentException - if port is not a valid integer

checkAddress

private static void checkAddress(String address,
 HAProxyProxiedProtocol.AddressFamily addrFamily)

Validate an address (IPv4, IPv6, Unix Socket)

Parameters:

address - human-readable address

addrFamily - the HAProxyProxiedProtocol.AddressFamily to check the address against

Throws:

IllegalArgumentException - if the address is invalid

checkPort

private static void checkPort(int port,
 HAProxyProxiedProtocol.AddressFamily addrFamily)

Validate the port depending on the addrFamily.

Parameters:

port - the UDP/TCP port

Throws:

IllegalArgumentException - if the port is out of range (0-65535 inclusive)

protocolVersion

public HAProxyProtocolVersion protocolVersion()

Returns the HAProxyProtocolVersion of this HAProxyMessage.

command

public HAProxyCommand command()

Returns the HAProxyCommand of this HAProxyMessage.

proxiedProtocol

public HAProxyProxiedProtocol proxiedProtocol()

Returns the HAProxyProxiedProtocol of this HAProxyMessage.

sourceAddress

public String sourceAddress()

Returns the human-readable source address of this HAProxyMessage or null if HAProxy performs health check with send-proxy-v2.

destinationAddress

public String destinationAddress()

Returns the human-readable destination address of this HAProxyMessage.

sourcePort

public int sourcePort()

Returns the UDP/TCP source port of this HAProxyMessage.

destinationPort

public int destinationPort()

Returns the UDP/TCP destination port of this HAProxyMessage.

tlvs

public List<HAProxyTLV> tlvs()

Returns a list of HAProxyTLV or an empty list if no TLVs are present.

TLVs are only available for the Proxy Protocol V2

tlvNumBytes

int tlvNumBytes()

touch

public HAProxyMessage touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public HAProxyMessage touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

retain

public HAProxyMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public HAProxyMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

tryRecord

private void tryRecord()

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

toString

public String toString()

Overrides:

toString in class Object