Package io.micronaut.http.ssl

Class SslBuilder<T>

java.lang.Object

io.micronaut.http.ssl.SslBuilder<T>

Type Parameters:

T - The server specific type to be built

Direct Known Subclasses:

AbstractServerSslBuilder, JdkClientSslBuilder, NettyClientSslBuilder

public abstract class SslBuilder<T>
extends Object

A class to build a key store and a trust store for use in adding SSL support to a server.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SslBuilder.CertificateSpec	Specification for building a KeyStore, either as a key store or a trust store.
protected static final class	SslBuilder.KeyStoreBasedCertificateSpec	Certificate spec based on SslConfiguration.KeyStoreConfiguration.getPath() or SslConfiguration.TrustStoreConfiguration.getPath().
protected static final class	SslBuilder.PemBasedCertificateSpec	Certificate spec based on SslConfiguration.KeyStoreConfiguration.getKeyPath() and SslConfiguration.KeyStoreConfiguration.getCertificatePath(), both of which must contain a PEM.

Constructor Summary

Constructors

Constructor	Description
SslBuilder(ResourceResolver resourceResolver)

Method Summary

Modifier and Type	Method	Description
abstract Optional<T>	build(SslConfiguration ssl)
abstract Optional<T>	build(SslConfiguration ssl, HttpVersion httpVersion)
protected KeyManagerFactory	getKeyManagerFactory(SslConfiguration ssl)
protected Optional<KeyStore>	getKeyStore(SslConfiguration ssl)
protected TrustManagerFactory	getTrustManagerFactory(SslConfiguration ssl)
protected TrustManagerFactory	getTrustManagerFactory(KeyStore store)
protected Optional<KeyStore>	getTrustStore(SslConfiguration ssl)
protected KeyStore	load(SslBuilder.CertificateSpec spec)
protected KeyStore	load(Optional<String> optionalType, String resource, Optional<String> optionalPassword)	Deprecated, for removal: This API element is subject to removal in a future version. Please override load(CertificateSpec) instead

Methods inherited from class java.lang.Object

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

Constructor Details

SslBuilder

public SslBuilder(ResourceResolver resourceResolver)

Parameters:

resourceResolver - The resource resolver

Method Details

build

public abstract Optional<T> build(SslConfiguration ssl)

Parameters:

ssl - The ssl configuration

Returns:

Builds the SSL configuration wrapped inside an optional

build

public abstract Optional<T> build(SslConfiguration ssl,
 HttpVersion httpVersion)

Parameters:

ssl - The ssl configuration

httpVersion - The http version

Returns:

Builds the SSL configuration wrapped inside an optional

getTrustManagerFactory

protected TrustManagerFactory getTrustManagerFactory(SslConfiguration ssl)

Parameters:

ssl - The ssl configuration

Returns:

The TrustManagerFactory

getTrustManagerFactory

protected TrustManagerFactory getTrustManagerFactory(KeyStore store)

Parameters:

store - The key store

Returns:

The TrustManagerFactory

getTrustStore

protected Optional<KeyStore> getTrustStore(SslConfiguration ssl)
                                    throws Exception

Parameters:

ssl - The ssl configuration

Returns:

An optional KeyStore

Throws:

Exception - if there is an error

getKeyManagerFactory

protected KeyManagerFactory getKeyManagerFactory(SslConfiguration ssl)

Parameters:

ssl - The ssl configuration

Returns:

The KeyManagerFactory

getKeyStore

protected Optional<KeyStore> getKeyStore(SslConfiguration ssl)
                                  throws Exception

Parameters:

ssl - The ssl configuration

Returns:

An optional KeyStore

Throws:

Exception - if there is an error

load

@Deprecated(forRemoval=true)
protected KeyStore load(Optional<String> optionalType,
 String resource,
 Optional<String> optionalPassword)
                 throws Exception

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

Please override load(CertificateSpec) instead

Parameters:

optionalType - The optional type

resource - The resource

optionalPassword - The optional password

Returns:

A KeyStore

Throws:

Exception - if there is an error

load

protected KeyStore load(SslBuilder.CertificateSpec spec)
                 throws Exception

Parameters:

spec - The configured certificate spec

Returns:

A KeyStore

Throws:

Exception - if there is an error