Package org.springframework.boot.web.server

Class WebServerSslBundle

java.lang.Object

org.springframework.boot.web.server.WebServerSslBundle

All Implemented Interfaces:

SslBundle

public final class WebServerSslBundle
extends Object
implements SslBundle

SslBundle backed by Ssl or an SslStoreProvider.

Since:

3.1.0

Author:

Scott Frederick, Phillip Webb

Field Summary

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

DEFAULT_PROTOCOL

Method Summary

Modifier and Type	Method	Description
static SslBundle	get(Ssl ssl)	Get the SslBundle that should be used for the given Ssl instance.
static SslBundle	get(Ssl ssl, SslBundles sslBundles)	Get the SslBundle that should be used for the given Ssl instance.
static SslBundle	get(Ssl ssl, SslBundles sslBundles, SslStoreProvider sslStoreProvider)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.1.0 for removal in 3.3.0 along with SslStoreProvider
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.ssl.SslBundle

createSslContext

Method Details

getStores

public SslStoreBundle getStores()

Description copied from interface: SslBundle

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

Specified by:

getStores in interface SslBundle

Returns:

the SslStoreBundle instance for this bundle

getKey

public SslBundleKey getKey()

Description copied from interface: SslBundle

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

Specified by:

getKey in interface SslBundle

Returns:

a reference to the SSL key that should be used

getOptions

public SslOptions getOptions()

Description copied from interface: SslBundle

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

Specified by:

getOptions in interface SslBundle

Returns:

the options that should be applied

getProtocol

public String getProtocol()

Description copied from interface: SslBundle

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

Specified by:

getProtocol in interface SslBundle

Returns:

the SSL protocol

See Also:

• SSLContext.getInstance(String)

getManagers

public SslManagerBundle getManagers()

Description copied from interface: SslBundle

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

Specified by:

getManagers in interface SslBundle

Returns:

the SslManagerBundle instance for this bundle

get

public static SslBundle get(Ssl ssl)
                     throws NoSuchSslBundleException

Get the SslBundle that should be used for the given Ssl instance.

Parameters:

ssl - the source ssl instance

Returns:

a SslBundle instance

Throws:

NoSuchSslBundleException - if a bundle lookup fails

get

public static SslBundle get(Ssl ssl,
 SslBundles sslBundles)
                     throws NoSuchSslBundleException

Get the SslBundle that should be used for the given Ssl instance.

Parameters:

ssl - the source ssl instance

sslBundles - the bundles that should be used when Ssl.getBundle() is set

Returns:

a SslBundle instance

Throws:

NoSuchSslBundleException - if a bundle lookup fails

get

@Deprecated(since="3.1.0",
            forRemoval=true)
public static SslBundle get(Ssl ssl,
 SslBundles sslBundles,
 SslStoreProvider sslStoreProvider)

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

since 3.1.0 for removal in 3.3.0 along with SslStoreProvider

Get the SslBundle that should be used for the given Ssl and SslStoreProvider instances.

Parameters:

ssl - the source Ssl instance

sslBundles - the bundles that should be used when Ssl.getBundle() is set

sslStoreProvider - the SslStoreProvider to use or null

Returns:

a SslBundle instance

Throws:

NoSuchSslBundleException - if a bundle lookup fails