Package org.kiwiproject.config

Class SSLContextConfiguration

java.lang.Object

org.kiwiproject.config.SSLContextConfiguration

All Implemented Interfaces:

KeyAndTrustStoreConfigProvider, TrustStoreConfigProvider

Direct Known Subclasses:

SecureEndpointsConfiguration

public class SSLContextConfiguration
extends Object
implements KeyAndTrustStoreConfigProvider

Configuration for standard/common properties required for secure (i.e. SSL/TLS) connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SSLContextConfiguration.Builder	A builder class for SSLContextConfiguration.

Constructor Summary

Constructors

Constructor	Description
SSLContextConfiguration()

Method Summary

Modifier and Type	Method	Description
static SSLContextConfiguration.Builder	builder()	Return a new builder instance.
String	getTrustStoreType()	Overrides and defines trust store type to be the same as keyStoreType, since this is the most common case.
SimpleSSLContextFactory	toSimpleSSLContextFactory()	Convert this configuration to a SimpleSSLContextFactory.
SSLContext	toSSLContext()	Convert this instance to a new SSLContext.
TlsContextConfiguration	toTlsContextConfiguration()	Convert this SSLContextConfiguration to a TlsContextConfiguration, using the keyStoreType for both the key and trust store type in the returned object.
TlsContextConfiguration	toTlsContextConfiguration(String trustStoreType)	Convert this SSLContextConfiguration to a TlsContextConfiguration, using the keyStoreType for the key and the specified trustStoreType as the trust store type in the returned object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kiwiproject.security.KeyAndTrustStoreConfigProvider

getKeyStorePassword, getKeyStorePath, getKeyStoreType

Methods inherited from interface org.kiwiproject.security.TrustStoreConfigProvider

getProtocol, getTrustStorePassword, getTrustStorePath, isVerifyHostname, toSslSocketFactory

Constructor Detail

SSLContextConfiguration

public SSLContextConfiguration()

Method Detail

builder

public static SSLContextConfiguration.Builder builder()

Return a new builder instance.

Returns:

builder instance

getTrustStoreType

public String getTrustStoreType()

Overrides and defines trust store type to be the same as keyStoreType, since this is the most common case.

This may be changed in the future by adding an explicit trust store type property, though we would keep the same default value.

Specified by:

getTrustStoreType in interface TrustStoreConfigProvider

Returns:

trust store type

See Also:

KeyStoreType.JKS

toSSLContext

public SSLContext toSSLContext()

Convert this instance to a new SSLContext.

If you would rather not create a new instance every time, use toSimpleSSLContextFactory() to obtain a factory that will always return the same SSLContext instance.

Specified by:

toSSLContext in interface KeyAndTrustStoreConfigProvider

Specified by:

toSSLContext in interface TrustStoreConfigProvider

Returns:

a new SSLContext instance

See Also:

KiwiSecurity.createSslContext(String, String, String, String, String, String, String)

Implementation Note:

This will always create a new instance, first creating a new SimpleSSLContextFactory and then using that to create the SSLContext.

toSimpleSSLContextFactory

public SimpleSSLContextFactory toSimpleSSLContextFactory()

Convert this configuration to a SimpleSSLContextFactory.

Returns:

a new instance

toTlsContextConfiguration

public TlsContextConfiguration toTlsContextConfiguration()

Convert this SSLContextConfiguration to a TlsContextConfiguration, using the keyStoreType for both the key and trust store type in the returned object.

Use toTlsContextConfiguration(String) if you need to specify a different trust store type.

Returns:

a new TlsContextConfiguration instance

See Also:

toTlsContextConfiguration(String)

toTlsContextConfiguration

public TlsContextConfiguration toTlsContextConfiguration(String trustStoreType)

Convert this SSLContextConfiguration to a TlsContextConfiguration, using the keyStoreType for the key and the specified trustStoreType as the trust store type in the returned object.

Parameters:

trustStoreType - the type of trust store to use

Returns:

a new TlsContextConfiguration instance