Package org.springframework.boot.ssl

Interface SslManagerBundle

public interface SslManagerBundle

A bundle of key and trust managers that can be used to establish an SSL connection. Instances are usually created from an SslStoreBundle.

Since:

3.1.0

Author:

Scott Frederick, Moritz Halbritter

See Also:

• SslStoreBundle
• SslBundle.getManagers()

Method Summary

Modifier and Type	Method	Description
default SSLContext	createSslContext(String protocol)	Factory method to create a new SSLContext for the key managers and trust managers managed by this instance.
static SslManagerBundle	from(TrustManager... trustManagers)	Factory method to create a new SslManagerBundle using the given TrustManagers and the default KeyManagerFactory.
static SslManagerBundle	from(TrustManagerFactory trustManagerFactory)	Factory method to create a new SslManagerBundle using the given TrustManagerFactory and the default KeyManagerFactory.
static SslManagerBundle	from(SslStoreBundle storeBundle, SslBundleKey key)	Factory method to create a new SslManagerBundle backed by the given SslBundle and SslBundleKey.
KeyManagerFactory	getKeyManagerFactory()	Return the KeyManagerFactory used to establish identity.
default KeyManager[]	getKeyManagers()	Return the KeyManager instances used to establish identity.
TrustManagerFactory	getTrustManagerFactory()	Return the TrustManagerFactory used to establish trust.
default TrustManager[]	getTrustManagers()	Return the TrustManager instances used to establish trust.
static SslManagerBundle	of(KeyManagerFactory keyManagerFactory, TrustManagerFactory trustManagerFactory)	Factory method to create a new SslManagerBundle instance.

Method Details

getKeyManagers

default KeyManager[] getKeyManagers()

Return the KeyManager instances used to establish identity.

Returns:

the key managers

getKeyManagerFactory

KeyManagerFactory getKeyManagerFactory()

Return the KeyManagerFactory used to establish identity.

Returns:

the key manager factory

getTrustManagers

default TrustManager[] getTrustManagers()

Return the TrustManager instances used to establish trust.

Returns:

the trust managers

getTrustManagerFactory

TrustManagerFactory getTrustManagerFactory()

Return the TrustManagerFactory used to establish trust.

Returns:

the trust manager factory

createSslContext

default SSLContext createSslContext(String protocol)

Factory method to create a new SSLContext for the key managers and trust managers managed by this instance.

Parameters:

protocol - the standard name of the SSL protocol. See SSLContext.getInstance(String)

Returns:

a new SSLContext instance

of

static SslManagerBundle of(KeyManagerFactory keyManagerFactory,
 TrustManagerFactory trustManagerFactory)

Factory method to create a new SslManagerBundle instance.

Parameters:

keyManagerFactory - the key manager factory

trustManagerFactory - the trust manager factory

Returns:

a new SslManagerBundle instance

from

static SslManagerBundle from(SslStoreBundle storeBundle,
 SslBundleKey key)

Factory method to create a new SslManagerBundle backed by the given SslBundle and SslBundleKey.

Parameters:

storeBundle - the SSL store bundle

key - the key reference

Returns:

a new SslManagerBundle instance

from

static SslManagerBundle from(TrustManagerFactory trustManagerFactory)

Factory method to create a new SslManagerBundle using the given TrustManagerFactory and the default KeyManagerFactory.

Parameters:

trustManagerFactory - the trust manager factory

Returns:

a new SslManagerBundle instance

Since:

3.5.0

from

static SslManagerBundle from(TrustManager... trustManagers)

Factory method to create a new SslManagerBundle using the given TrustManagers and the default KeyManagerFactory.

Parameters:

trustManagers - the trust managers to use

Returns:

a new SslManagerBundle instance

Since:

3.5.0