Package org.springframework.boot.ssl

Interface SslBundle

All Known Implementing Classes:

PropertiesSslBundle, WebServerSslBundle

public interface SslBundle

A bundle of trust material that can be used to establish an SSL connection.

Since:

3.1.0

Author:

Scott Frederick, Moritz Halbritter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROTOCOL	The default protocol to use.

Method Summary

Modifier and Type	Method	Description
default SSLContext	createSslContext()	Factory method to create a new SSLContext for this bundle.
SslBundleKey	getKey()	Return a reference to the key that should be used for this bundle or SslBundleKey.NONE.
SslManagerBundle	getManagers()	Return the SslManagerBundle that can be used to access this bundle's key and trust managers.
SslOptions	getOptions()	Return SslOptions that should be applied when establishing the SSL connection.
String	getProtocol()	Return the protocol to use when establishing the connection.
SslStoreBundle	getStores()	Return the SslStoreBundle that can be used to access this bundle's key and trust stores.
static SslBundle	of(SslStoreBundle stores)	Factory method to create a new SslBundle instance.
static SslBundle	of(SslStoreBundle stores, SslBundleKey key)	Factory method to create a new SslBundle instance.
static SslBundle	of(SslStoreBundle stores, SslBundleKey key, SslOptions options)	Factory method to create a new SslBundle instance.
static SslBundle	of(SslStoreBundle stores, SslBundleKey key, SslOptions options, String protocol)	Factory method to create a new SslBundle instance.
static SslBundle	of(SslStoreBundle stores, SslBundleKey key, SslOptions options, String protocol, SslManagerBundle managers)	Factory method to create a new SslBundle instance.
static SslBundle	systemDefault()	Factory method to create a new SslBundle which uses the system defaults.

Field Details

DEFAULT_PROTOCOL

static final String DEFAULT_PROTOCOL

The default protocol to use.

See Also:

• Constant Field Values

Method Details

getStores

SslStoreBundle getStores()

Return the SslStoreBundle that can be used to access this bundle's key and trust stores.

Returns:

the SslStoreBundle instance for this bundle

getKey

SslBundleKey getKey()

Return a reference to the key that should be used for this bundle or SslBundleKey.NONE.

Returns:

a reference to the SSL key that should be used

getOptions

SslOptions getOptions()

Return SslOptions that should be applied when establishing the SSL connection.

Returns:

the options that should be applied

getProtocol

String getProtocol()

Return the protocol to use when establishing the connection. Values should be supported by SSLContext.getInstance(String).

Returns:

the SSL protocol

See Also:

• SSLContext.getInstance(String)

getManagers

SslManagerBundle getManagers()

Return the SslManagerBundle that can be used to access this bundle's key and trust managers.

Returns:

the SslManagerBundle instance for this bundle

createSslContext

default SSLContext createSslContext()

Factory method to create a new SSLContext for this bundle.

Returns:

a new SSLContext instance

of

static SslBundle of(SslStoreBundle stores)

Factory method to create a new SslBundle instance.

Parameters:

stores - the stores or null

Returns:

a new SslBundle instance

of

static SslBundle of(SslStoreBundle stores,
 SslBundleKey key)

Factory method to create a new SslBundle instance.

Parameters:

stores - the stores or null

key - the key or null

Returns:

a new SslBundle instance

of

static SslBundle of(SslStoreBundle stores,
 SslBundleKey key,
 SslOptions options)

Factory method to create a new SslBundle instance.

Parameters:

stores - the stores or null

key - the key or null

options - the options or null

Returns:

a new SslBundle instance

of

static SslBundle of(SslStoreBundle stores,
 SslBundleKey key,
 SslOptions options,
 String protocol)

Factory method to create a new SslBundle instance.

Parameters:

stores - the stores or null

key - the key or null

options - the options or null

protocol - the protocol or null

Returns:

a new SslBundle instance

of

static SslBundle of(SslStoreBundle stores,
 SslBundleKey key,
 SslOptions options,
 String protocol,
 SslManagerBundle managers)

Factory method to create a new SslBundle instance.

Parameters:

stores - the stores or null

key - the key or null

options - the options or null

protocol - the protocol or null

managers - the managers or null

Returns:

a new SslBundle instance

systemDefault

static SslBundle systemDefault()

Factory method to create a new SslBundle which uses the system defaults.

Returns:

a new SslBundle instance

Since:

3.5.0