Module io.helidon.webserver

Package io.helidon.webserver

Record Class ProxyProtocolV2Data.Tlv.Ssl

java.lang.Object

java.lang.Record

io.helidon.webserver.ProxyProtocolV2Data.Tlv.Ssl

Record Components:

client - Client flags bitfield.

verify - Verification status.

subTlvs - The SSL subtype TLVs.

All Implemented Interfaces:

ProxyProtocolV2Data.Tlv

Enclosing interface:

ProxyProtocolV2Data.Tlv

public static record ProxyProtocolV2Data.Tlv.Ssl(int client, int verify, List<ProxyProtocolV2Data.Tlv> subTlvs)
extends Record
implements ProxyProtocolV2Data.Tlv

Contains information about the SSL presented by the proxied client.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.ProxyProtocolV2Data.Tlv

ProxyProtocolV2Data.Tlv.Alpn, ProxyProtocolV2Data.Tlv.Authority, ProxyProtocolV2Data.Tlv.Crc32c, ProxyProtocolV2Data.Tlv.Netns, ProxyProtocolV2Data.Tlv.Noop, ProxyProtocolV2Data.Tlv.Ssl, ProxyProtocolV2Data.Tlv.SslCipher, ProxyProtocolV2Data.Tlv.SslCn, ProxyProtocolV2Data.Tlv.SslKeyAlg, ProxyProtocolV2Data.Tlv.SslSigAlg, ProxyProtocolV2Data.Tlv.SslVersion, ProxyProtocolV2Data.Tlv.UniqueId, ProxyProtocolV2Data.Tlv.Unregistered

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PP2_CLIENT_CERT_CONN	The PP2_CLIENT_CERT_CONN bitflag.
static final int	PP2_CLIENT_CERT_SESS	The PP2_CLIENT_CERT_SESS bitflag.
static final int	PP2_CLIENT_SSL	The PP2_CLIENT_SSL bitflag.

Fields inherited from interface io.helidon.webserver.ProxyProtocolV2Data.Tlv

PP2_SUBTYPE_SSL_CIPHER, PP2_SUBTYPE_SSL_CN, PP2_SUBTYPE_SSL_KEY_ALG, PP2_SUBTYPE_SSL_SIG_ALG, PP2_SUBTYPE_SSL_VERSION, PP2_TYPE_ALPN, PP2_TYPE_AUTHORITY, PP2_TYPE_CRC32C, PP2_TYPE_NETNS, PP2_TYPE_NOOP, PP2_TYPE_SSL, PP2_TYPE_UNIQUE_ID

Constructor Summary

Constructors

Constructor	Description
Ssl(int client, int verify, List<ProxyProtocolV2Data.Tlv> subTlvs)	Creates an instance of a Ssl record class.

Method Summary

Modifier and Type	Method	Description
int	client()	Returns the value of the client record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	hasClientCertConn()	Tests whether the PP2_CLIENT_CERT_CONN flag is set.
boolean	hasClientCertSess()	Tests whether the PP2_CLIENT_CERT_SESS flag is set.
boolean	hasClientSsl()	Tests whether the PP2_CLIENT_SSL flag is set.
final int	hashCode()	Returns a hash code value for this object.
boolean	isSuccessfullyVerified()	Tests whether the client presented a certificate and it was successfully verified.
List<ProxyProtocolV2Data.Tlv>	subTlvs()	Returns the value of the subTlvs record component.
final String	toString()	Returns a string representation of this record class.
int	type()	Returns the TLV's type identifier.
int	verify()	Returns the value of the verify record component.

Methods inherited from class java.lang.Object

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

Field Details

PP2_CLIENT_SSL

public static final int PP2_CLIENT_SSL

The PP2_CLIENT_SSL bitflag.

See Also:

• Constant Field Values

PP2_CLIENT_CERT_CONN

public static final int PP2_CLIENT_CERT_CONN

The PP2_CLIENT_CERT_CONN bitflag.

See Also:

• Constant Field Values

PP2_CLIENT_CERT_SESS

public static final int PP2_CLIENT_CERT_SESS

The PP2_CLIENT_CERT_SESS bitflag.

See Also:

• Constant Field Values

Constructor Details

Ssl

public Ssl(int client,
 int verify,
 List<ProxyProtocolV2Data.Tlv> subTlvs)

Creates an instance of a Ssl record class.

Parameters:

client - the value for the client record component

verify - the value for the verify record component

subTlvs - the value for the subTlvs record component

Method Details

type

public int type()

Description copied from interface: ProxyProtocolV2Data.Tlv

Returns the TLV's type identifier.

Specified by:

type in interface ProxyProtocolV2Data.Tlv

Returns:

The type identifier.

isSuccessfullyVerified

public boolean isSuccessfullyVerified()

Tests whether the client presented a certificate and it was successfully verified.

Returns:

True if the client cert was present and valid.

hasClientSsl

public boolean hasClientSsl()

Tests whether the PP2_CLIENT_SSL flag is set.

Returns:

True if the PP2_CLIENT_SSL is set.

hasClientCertConn

public boolean hasClientCertConn()

Tests whether the PP2_CLIENT_CERT_CONN flag is set.

Returns:

True if the PP2_CLIENT_CERT_CONN is set.

hasClientCertSess

public boolean hasClientCertSess()

Tests whether the PP2_CLIENT_CERT_SESS flag is set.

Returns:

True if the PP2_CLIENT_CERT_SESS is set.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

client

public int client()

Returns the value of the client record component.

Returns:

the value of the client record component

verify

public int verify()

Returns the value of the verify record component.

Returns:

the value of the verify record component

subTlvs

public List<ProxyProtocolV2Data.Tlv> subTlvs()

Returns the value of the subTlvs record component.

Returns:

the value of the subTlvs record component