Package org.springframework.boot.ssl

Interface SslBundleKey

public interface SslBundleKey

A reference to a single key obtained via SslBundle.

Since:

3.1.0

Author:

Phillip Webb

Field Summary

Fields

Modifier and Type	Field	Description
static final SslBundleKey	NONE	SslBundleKey that returns no values.

Method Summary

Modifier and Type	Method	Description
default void	assertContainsAlias(KeyStore keyStore)	Assert that the alias is contained in the given keystore.
String	getAlias()	Return the alias of the key or null if the key has no alias.
String	getPassword()	Return the password that should be used to access the key or null if no password is required.
static SslBundleKey	of(String password)	Factory method to create a new SslBundleKey instance.
static SslBundleKey	of(String password, String alias)	Factory method to create a new SslBundleKey instance.

Field Details

NONE

static final SslBundleKey NONE

SslBundleKey that returns no values.

Method Details

getPassword

String getPassword()

Return the password that should be used to access the key or null if no password is required.

Returns:

the key password

getAlias

String getAlias()

Return the alias of the key or null if the key has no alias.

Returns:

the key alias

assertContainsAlias

default void assertContainsAlias(KeyStore keyStore)

Assert that the alias is contained in the given keystore.

Parameters:

keyStore - the keystore to check

of

static SslBundleKey of(String password)

Factory method to create a new SslBundleKey instance.

Parameters:

password - the password used to access the key

Returns:

a new SslBundleKey instance

of

static SslBundleKey of(String password,
 String alias)

Factory method to create a new SslBundleKey instance.

Parameters:

password - the password used to access the key

alias - the alias of the key

Returns:

a new SslBundleKey instance