Record Class SSLConfiguration

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.ssl.SSLConfiguration

Record Components:

enabled - if the ssl configuration is enabled.

clientAuth - if client authorization should be required.

trustCertificatePath - the trusted certificate for remote certificate validation.

certificatePath - the path to an X509 certificate chain in the pem format.

privateKeyPath - the path to a PKCS#8 private key in PEM format.

privateKeyPassword - the password of the private key file, null if not password protected.

public record SSLConfiguration(boolean enabled, boolean clientAuth, @Nullable Path trustCertificatePath, @Nullable Path certificatePath, @Nullable Path privateKeyPath, @Nullable String privateKeyPassword)
extends Record

Represents the configuration option for ssl. A ssl configuration can be enabled without any certificates given, meaning that the server/client should use self-signed certificates and an insecure trust store.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable Path	certificatePath	The field for the certificatePath record component.
private final boolean	clientAuth	The field for the clientAuth record component.
private final boolean	enabled	The field for the enabled record component.
private final @Nullable String	privateKeyPassword	The field for the privateKeyPassword record component.
private final @Nullable Path	privateKeyPath	The field for the privateKeyPath record component.
private final @Nullable Path	trustCertificatePath	The field for the trustCertificatePath record component.

Constructor Summary

Constructors

Constructor	Description
SSLConfiguration(boolean enabled, boolean clientAuth, @Nullable Path trustCertificatePath, @Nullable Path certificatePath, @Nullable Path privateKeyPath, @Nullable String privateKeyPassword)	Creates an instance of a SSLConfiguration record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Path	certificatePath()	Returns the value of the certificatePath record component.
boolean	clientAuth()	Returns the value of the clientAuth record component.
boolean	enabled()	Returns the value of the enabled record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	privateKeyPassword()	Returns the value of the privateKeyPassword record component.
@Nullable Path	privateKeyPath()	Returns the value of the privateKeyPath record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Path	trustCertificatePath()	Returns the value of the trustCertificatePath record component.

Methods inherited from class Object

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

Field Details

enabled

private final boolean enabled

The field for the enabled record component.

clientAuth

private final boolean clientAuth

The field for the clientAuth record component.

trustCertificatePath

@Nullable
private final @Nullable Path trustCertificatePath

The field for the trustCertificatePath record component.

certificatePath

@Nullable
private final @Nullable Path certificatePath

The field for the certificatePath record component.

privateKeyPath

@Nullable
private final @Nullable Path privateKeyPath

The field for the privateKeyPath record component.

privateKeyPassword

@Nullable
private final @Nullable String privateKeyPassword

The field for the privateKeyPassword record component.

Constructor Details

SSLConfiguration

public SSLConfiguration(boolean enabled,
 boolean clientAuth,
 @Nullable
 @Nullable Path trustCertificatePath,
 @Nullable
 @Nullable Path certificatePath,
 @Nullable
 @Nullable Path privateKeyPath,
 @Nullable
 @Nullable String privateKeyPassword)

Creates an instance of a SSLConfiguration record class.

Parameters:

enabled - the value for the enabled record component

clientAuth - the value for the clientAuth record component

trustCertificatePath - the value for the trustCertificatePath record component

certificatePath - the value for the certificatePath record component

privateKeyPath - the value for the privateKeyPath record component

privateKeyPassword - the value for the privateKeyPassword record component

Method Details

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 the compare method from their corresponding wrapper classes.

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.

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component

clientAuth

public boolean clientAuth()

Returns the value of the clientAuth record component.

Returns:

the value of the clientAuth record component

trustCertificatePath

@Nullable
public @Nullable Path trustCertificatePath()

Returns the value of the trustCertificatePath record component.

Returns:

the value of the trustCertificatePath record component

certificatePath

@Nullable
public @Nullable Path certificatePath()

Returns the value of the certificatePath record component.

Returns:

the value of the certificatePath record component

privateKeyPath

@Nullable
public @Nullable Path privateKeyPath()

Returns the value of the privateKeyPath record component.

Returns:

the value of the privateKeyPath record component

privateKeyPassword

@Nullable
public @Nullable String privateKeyPassword()

Returns the value of the privateKeyPassword record component.

Returns:

the value of the privateKeyPassword record component