Class HAProxySSLTLV

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.haproxy.HAProxyTLV

io.netty.handler.codec.haproxy.HAProxySSLTLV

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public final class HAProxySSLTLV
extends HAProxyTLV

Represents a HAProxyTLV of the type HAProxyTLV.Type.PP2_TYPE_SSL. This TLV encapsulates other TLVs and has additional information like verification information and a client bitfield.

Nested Class Summary

Nested classes/interfaces inherited from class HAProxyTLV

HAProxyTLV.Type

Modifier and Type	Class	Description
static enum	HAProxyTLV.Type	The registered types a TLV can have regarding the PROXY protocol 1.5 spec

Constructor Summary

Constructors

Constructor	Description
HAProxySSLTLV(int verify, byte clientBitField, List<HAProxyTLV> tlvs)	Creates a new HAProxySSLTLV

Method Summary

Modifier and Type	Method	Description
byte	client()	Returns the client bit field
List<HAProxyTLV>	encapsulatedTLVs()	Returns an unmodifiable Set of encapsulated HAProxyTLVs.
boolean	isPP2ClientCertConn()	Returns true if the bit field for PP2_CLIENT_CERT_CONN was set
boolean	isPP2ClientCertSess()	Returns true if the bit field for PP2_CLIENT_CERT_SESS was set
boolean	isPP2ClientSSL()	Returns true if the bit field for PP2_CLIENT_SSL was set
String	toString()
int	verify()	Returns the verification result

Methods inherited from class HAProxyTLV

copy, duplicate, replace, retain, retain, retainedDuplicate, touch, touch, type, typeByteValue

Modifier and Type	Method	Description
HAProxyTLV	copy()	Creates a deep copy of this ByteBufHolder.
HAProxyTLV	duplicate()	Duplicates this ByteBufHolder.
HAProxyTLV	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
HAProxyTLV	retain()	Increases the reference count by 1.
HAProxyTLV	retain(int increment)	Increases the reference count by the specified increment.
HAProxyTLV	retainedDuplicate()	Duplicates this ByteBufHolder.
HAProxyTLV	touch()	Records the current access location of this object for debugging purposes.
HAProxyTLV	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
HAProxyTLV.Type	type()	Returns the HAProxyTLV.Type of this TLV
byte	typeByteValue()	Returns the type of the TLV as byte

Methods inherited from class DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

Modifier and Type	Method	Description
ByteBuf	content()	Return the data which is held by this ByteBufHolder.
protected final String	contentToString()	Return ByteBuf.toString() without checking the reference count first.
boolean	equals(Object o)	This implementation of the equals operation is restricted to work only with instances of the same class.
int	hashCode()
int	refCnt()	Returns the reference count of this object.
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.

Methods inherited from class Object

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

Constructor Details

HAProxySSLTLV

public HAProxySSLTLV(int verify,
 byte clientBitField,
 List<HAProxyTLV> tlvs)

Creates a new HAProxySSLTLV

Parameters:

verify - the verification result as defined in the specification for the pp2_tlv_ssl struct (see https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt)

clientBitField - the bitfield with client information

tlvs - the encapsulated HAProxyTLVs

Method Details

isPP2ClientCertConn

public boolean isPP2ClientCertConn()

Returns true if the bit field for PP2_CLIENT_CERT_CONN was set

isPP2ClientSSL

public boolean isPP2ClientSSL()

Returns true if the bit field for PP2_CLIENT_SSL was set

isPP2ClientCertSess

public boolean isPP2ClientCertSess()

Returns true if the bit field for PP2_CLIENT_CERT_SESS was set

client

public byte client()

Returns the client bit field

verify

public int verify()

Returns the verification result

encapsulatedTLVs

public List<HAProxyTLV> encapsulatedTLVs()

Returns an unmodifiable Set of encapsulated HAProxyTLVs.

toString

public String toString()

Overrides:

toString in class HAProxyTLV