Package org.springframework.boot.ssl.pem

Interface PemSslStore

public interface PemSslStore

An individual trust or key store that has been loaded from PEM content.

Since:

3.2.0

Author:

Phillip Webb

See Also:

• PemSslStoreDetails
• PemContent

Method Summary

Modifier and Type	Method	Description
String	alias()	The alias used when setting entries in the KeyStore.
List<X509Certificate>	certificates()	The certificates for this store.
static PemSslStore	load(PemSslStoreDetails details)	Return a PemSslStore instance loaded using the given PemSslStoreDetails.
static PemSslStore	of(String type, String alias, String password, List<X509Certificate> certificates, PrivateKey privateKey)	Factory method that can be used to create a new PemSslStore with the given values.
static PemSslStore	of(String type, List<X509Certificate> certificates, PrivateKey privateKey)	Factory method that can be used to create a new PemSslStore with the given values.
static PemSslStore	of(List<X509Certificate> certificates, PrivateKey privateKey)	Factory method that can be used to create a new PemSslStore with the given values.
String	password()	The password used when setting key entries in the KeyStore.
PrivateKey	privateKey()	The private key for this store or null.
String	type()	The key store type, for example JKS or PKCS11.
default PemSslStore	withAlias(String alias)	Return a new PemSslStore instance with a new alias.
default PemSslStore	withPassword(String password)	Return a new PemSslStore instance with a new password.

Method Details

type

String type()

The key store type, for example JKS or PKCS11. A null value will use KeyStore.getDefaultType()).

Returns:

the key store type

alias

String alias()

The alias used when setting entries in the KeyStore.

Returns:

the alias

password

String password()

The password used when setting key entries in the KeyStore.

Returns:

the password

certificates

List<X509Certificate> certificates()

The certificates for this store. When a private key is present the returned value is treated as a certificate chain, otherwise it is treated a list of certificates that should all be registered.

Returns:

the X509 certificates

privateKey

PrivateKey privateKey()

The private key for this store or null.

Returns:

the private key

withAlias

default PemSslStore withAlias(String alias)

Return a new PemSslStore instance with a new alias.

Parameters:

alias - the new alias

Returns:

a new PemSslStore instance

withPassword

default PemSslStore withPassword(String password)

Return a new PemSslStore instance with a new password.

Parameters:

password - the new password

Returns:

a new PemSslStore instance

load

static PemSslStore load(PemSslStoreDetails details)
                 throws IOException

Return a PemSslStore instance loaded using the given PemSslStoreDetails.

Parameters:

details - the PEM store details

Returns:

a loaded PemSslStore or null.

Throws:

IOException - on IO error

of

static PemSslStore of(String type,
 List<X509Certificate> certificates,
 PrivateKey privateKey)

Factory method that can be used to create a new PemSslStore with the given values.

Parameters:

type - the key store type

certificates - the certificates for this store

privateKey - the private key

Returns:

a new PemSslStore instance

of

static PemSslStore of(List<X509Certificate> certificates,
 PrivateKey privateKey)

Factory method that can be used to create a new PemSslStore with the given values.

Parameters:

certificates - the certificates for this store

privateKey - the private key

Returns:

a new PemSslStore instance

of

static PemSslStore of(String type,
 String alias,
 String password,
 List<X509Certificate> certificates,
 PrivateKey privateKey)

Factory method that can be used to create a new PemSslStore with the given values.

Parameters:

type - the key store type

alias - the alias used when setting entries in the KeyStore

password - the password used setting key entries in the KeyStore

certificates - the certificates for this store

privateKey - the private key

Returns:

a new PemSslStore instance