Package io.kroxylicious.proxy.config.tls

Record Class KeyStore

java.lang.Object

java.lang.Record

io.kroxylicious.proxy.config.tls.KeyStore

Record Components:

storeFile - location of a key store, or reference to a PEM file containing both private-key and certificate/intermediates.

storePasswordProvider - provider for the store password or null if store does not require a password.

keyPasswordProvider - provider for the key password. if null the password obtained from the storePasswordProvider will be used to decrypt the key.

storeType - specifies the server key type. Legal values are those types supported by the platform KeyStore, and PEM (for X-509 certificates express in PEM format).

All Implemented Interfaces:

KeyProvider

public record KeyStore(String storeFile, PasswordProvider storePasswordProvider, PasswordProvider keyPasswordProvider, String storeType)
extends Record
implements KeyProvider

A KeyProvider backed by a Java Truststore.

Constructor Summary

Constructors

Constructor	Description
KeyStore(String storeFile, PasswordProvider storePasswordProvider, PasswordProvider keyPasswordProvider, String storeType)	Creates an instance of a KeyStore record class.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(KeyProviderVisitor<T> visitor)	Visits the trust provider KeyProviderVisitor.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getType()
final int	hashCode()	Returns a hash code value for this object.
boolean	isPemType()
PasswordProvider	keyPasswordProvider()	Returns the value of the keyPasswordProvider record component.
String	storeFile()	Returns the value of the storeFile record component.
PasswordProvider	storePasswordProvider()	Returns the value of the storePasswordProvider record component.
String	storeType()	Returns the value of the storeType record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyStore

public KeyStore(String storeFile,
 @Nullable
 PasswordProvider storePasswordProvider,
 @Nullable
 PasswordProvider keyPasswordProvider,
 String storeType)

Creates an instance of a KeyStore record class.

Parameters:

storeFile - the value for the storeFile record component

storePasswordProvider - the value for the storePasswordProvider record component

keyPasswordProvider - the value for the keyPasswordProvider record component

storeType - the value for the storeType record component

Method Details

getType

public String getType()

isPemType

public boolean isPemType()

accept

public <T> T accept(KeyProviderVisitor<T> visitor)

Description copied from interface: KeyProvider

Visits the trust provider KeyProviderVisitor. Implementor should call one `visit` method on visitor.

Specified by:

accept in interface KeyProvider

Parameters:

visitor - visitor.

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

storeFile

public String storeFile()

Returns the value of the storeFile record component.

Returns:

the value of the storeFile record component

storePasswordProvider

@Nullable
public PasswordProvider storePasswordProvider()

Returns the value of the storePasswordProvider record component.

Returns:

the value of the storePasswordProvider record component

keyPasswordProvider

@Nullable
public PasswordProvider keyPasswordProvider()

Returns the value of the keyPasswordProvider record component.

Returns:

the value of the keyPasswordProvider record component

storeType

public String storeType()

Returns the value of the storeType record component.

Returns:

the value of the storeType record component