Package org.springframework.boot.ssl.pem

Class PemSslStoreBundle

java.lang.Object

org.springframework.boot.ssl.pem.PemSslStoreBundle

All Implemented Interfaces:

SslStoreBundle

public class PemSslStoreBundle
extends Object
implements SslStoreBundle

SslStoreBundle backed by PEM-encoded certificates and private keys.

Since:

3.1.0

Author:

Scott Frederick, Phillip Webb, Moritz Halbritter

Field Summary

Fields inherited from interface org.springframework.boot.ssl.SslStoreBundle

NONE

Constructor Summary

Constructors

Constructor	Description
PemSslStoreBundle(PemSslStoreDetails keyStoreDetails, PemSslStoreDetails trustStoreDetails)	Create a new PemSslStoreBundle instance.
PemSslStoreBundle(PemSslStoreDetails keyStoreDetails, PemSslStoreDetails trustStoreDetails, String alias)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.0 for removal in 3.4.0 in favor of PemSslStoreDetails.alias() in the keyStoreDetails and trustStoreDetails
PemSslStoreBundle(PemSslStore pemKeyStore, PemSslStore pemTrustStore)	Create a new PemSslStoreBundle instance.

Method Summary

Modifier and Type	Method	Description
KeyStore	getKeyStore()	Return a key store generated from the trust material or null.
String	getKeyStorePassword()	Return the password for the key in the key store or null.
KeyStore	getTrustStore()	Return a trust store generated from the trust material or null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PemSslStoreBundle

public PemSslStoreBundle(PemSslStoreDetails keyStoreDetails,
 PemSslStoreDetails trustStoreDetails)

Create a new PemSslStoreBundle instance.

Parameters:

keyStoreDetails - the key store details

trustStoreDetails - the trust store details

PemSslStoreBundle

@Deprecated(since="3.2.0",
            forRemoval=true)
public PemSslStoreBundle(PemSslStoreDetails keyStoreDetails,
 PemSslStoreDetails trustStoreDetails,
 String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2.0 for removal in 3.4.0 in favor of PemSslStoreDetails.alias() in the keyStoreDetails and trustStoreDetails

Create a new PemSslStoreBundle instance.

Parameters:

keyStoreDetails - the key store details

trustStoreDetails - the trust store details

alias - the alias to use or null to use a default alias

PemSslStoreBundle

public PemSslStoreBundle(PemSslStore pemKeyStore,
 PemSslStore pemTrustStore)

Create a new PemSslStoreBundle instance.

Parameters:

pemKeyStore - the PEM key store

pemTrustStore - the PEM trust store

Since:

3.2.0

Method Details

getKeyStore

public KeyStore getKeyStore()

Description copied from interface: SslStoreBundle

Return a key store generated from the trust material or null.

Specified by:

getKeyStore in interface SslStoreBundle

Returns:

the key store

getKeyStorePassword

public String getKeyStorePassword()

Description copied from interface: SslStoreBundle

Return the password for the key in the key store or null.

Specified by:

getKeyStorePassword in interface SslStoreBundle

Returns:

the key password

getTrustStore

public KeyStore getTrustStore()

Description copied from interface: SslStoreBundle

Return a trust store generated from the trust material or null.

Specified by:

getTrustStore in interface SslStoreBundle

Returns:

the trust store