Top Description Fields Constructors Methods
io.netty.contrib.handler.codec.haproxy

public final Class HAProxySSLTLV

extends HAProxyTLV
Class Inheritance
Imports
io.netty5.buffer.Buffer, io.netty5.util.internal.StringUtil, java.util.Collections, .List
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.

Field Summary

Modifier and TypeField and Description
private final byte
clientBitField

private final List<HAProxyTLV>
tlvs

private final int
verify

Constructor Summary

AccessConstructor and Description
public
HAProxySSLTLV(final int
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)
verify, final byte
the bitfield with client information
clientBitField, final List<HAProxyTLV>
the encapsulated HAProxyTLVs
tlvs)

Creates a new HAProxySSLTLV

pack-priv
HAProxySSLTLV(final int
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)
verify, final byte
the bitfield with client information
clientBitField, final List<HAProxyTLV>
the encapsulated HAProxyTLVs
tlvs, final Buffer
the raw TLV content
rawContent)

Creates a new HAProxySSLTLV

Method Summary

Modifier and TypeMethod and Description
public byte
client()

Returns the client bit field

pack-priv Buffer
content()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.content.

pack-priv int
contentNumBytes()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.contentNumBytes.

public List<HAProxyTLV>
encapsulatedTLVs()

Returns an unmodifiable Set of encapsulated HAProxyTLVs.

public boolean
isPP2ClientCertConn()

Returns true if the bit field for PP2_CLIENT_CERT_CONN was set

public boolean
isPP2ClientCertSess()

Returns true if the bit field for PP2_CLIENT_CERT_SESS was set

public boolean
isPP2ClientSSL()

Returns true if the bit field for PP2_CLIENT_SSL was set

protected HAProxyTLV
receive(Buffer
The Buffer that is received by the recipient, and needs to be wrapped in a new BufferHolder instance.
buf)

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.receive.

Called when a sent BufferHolder is received by the recipient.
public String
toString()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.toString.

Returns a string representation of the object.
public int
verify()

Returns the verification result

Inherited from io.netty.contrib.handler.codec.haproxy.HAProxyTLV:
totalNumBytestypetypeByteValue

Field Detail

clientBitFieldback to summary
private final byte clientBitField
tlvsback to summary
private final List<HAProxyTLV> tlvs
verifyback to summary
private final int verify

Constructor Detail

HAProxySSLTLVback to summary
public HAProxySSLTLV(final int verify, final byte clientBitField, final List<HAProxyTLV> tlvs)

Creates a new HAProxySSLTLV

Parameters
verify:int

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:byte

the bitfield with client information

tlvs:List<HAProxyTLV>

the encapsulated HAProxyTLVs

HAProxySSLTLVback to summary
pack-priv HAProxySSLTLV(final int verify, final byte clientBitField, final List<HAProxyTLV> tlvs, final Buffer rawContent)

Creates a new HAProxySSLTLV

Parameters
verify:int

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:byte

the bitfield with client information

tlvs:List<HAProxyTLV>

the encapsulated HAProxyTLVs

rawContent:Buffer

the raw TLV content

Method Detail

clientback to summary
public byte client()

Returns the client bit field

contentback to summary
pack-priv Buffer content()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.content.

contentNumBytesback to summary
pack-priv int contentNumBytes()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.contentNumBytes.

Annotations
@Override
encapsulatedTLVsback to summary
public List<HAProxyTLV> encapsulatedTLVs()

Returns an unmodifiable Set of encapsulated HAProxyTLVs.

isPP2ClientCertConnback to summary
public boolean isPP2ClientCertConn()

Returns true if the bit field for PP2_CLIENT_CERT_CONN was set

isPP2ClientCertSessback to summary
public boolean isPP2ClientCertSess()

Returns true if the bit field for PP2_CLIENT_CERT_SESS was set

isPP2ClientSSLback to summary
public boolean isPP2ClientSSL()

Returns true if the bit field for PP2_CLIENT_SSL was set

receiveback to summary
protected HAProxyTLV receive(Buffer buf)

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.receive.

Doc from io.netty5.buffer.BufferHolder.receive.

Called when a sent BufferHolder is received by the recipient. The BufferHolder should return a new concrete instance, that wraps the given Buffer object.

Parameters
buf:Buffer

The Buffer that is received by the recipient, and needs to be wrapped in a new BufferHolder instance.

Returns:HAProxyTLV

A new buffer holder instance, containing the given buffer.

Annotations
@Override
toStringback to summary
public String toString()

Overrides io.netty.contrib.handler.codec.haproxy.HAProxyTLV.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
verifyback to summary
public int verify()

Returns the verification result