Package org.kiwiproject.security

Class SimpleSSLContextFactory

java.lang.Object

org.kiwiproject.security.SimpleSSLContextFactory

public class SimpleSSLContextFactory
extends Object

A "simple" factory class that makes it simpler to to create SSLContext instances.

Construct using one of the public constructors or via the builder().

This abstracts the much lower level KiwiSecurity class.

See Also:

KiwiSecurity

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
SimpleSSLContextFactory(String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword, String protocol)	Create a new SimpleSSLContextFactory with verifyHostname set to true.
SimpleSSLContextFactory(String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword, String protocol, boolean verifyHostname)	Create a new SimpleSSLContextFactory.

Method Summary

Modifier and Type	Method	Description
static SimpleSSLContextFactory.Builder	builder()	Return a new builder instance.
SSLContext	getSslContext()	Create/get a SSLContext instance for the key and trust store properties and protocol that this SimpleSSLContextFactory instance was built with.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSSLContextFactory

public SimpleSSLContextFactory(String keyStorePath,
                               String keyStorePassword,
                               String trustStorePath,
                               String trustStorePassword,
                               String protocol)

Create a new SimpleSSLContextFactory with verifyHostname set to true.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

protocol - the protocol to use

SimpleSSLContextFactory

public SimpleSSLContextFactory(String keyStorePath,
                               String keyStorePassword,
                               String trustStorePath,
                               String trustStorePassword,
                               String protocol,
                               boolean verifyHostname)

Create a new SimpleSSLContextFactory.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

protocol - the protocol to use

verifyHostname - whether to verify host names or not

Method Detail

builder

public static SimpleSSLContextFactory.Builder builder()

Return a new builder instance.

Returns:

new Builder

getSslContext

public SSLContext getSslContext()

Create/get a SSLContext instance for the key and trust store properties and protocol that this SimpleSSLContextFactory instance was built with.

Returns:

a new SSLContext instance when first called; all subsequent calls return the same cached instance

Implementation Note:

This is intended to be called infrequently, e.g. once when a service/app starts. Thus, making it synchronized was the easiest way to ensure thread-safety.