io.micronaut.http.server.netty.ssl

Class CertificateProvidedSslBuilder

java.lang.Object

io.micronaut.http.ssl.SslBuilder<io.netty.handler.ssl.SslContext>

io.micronaut.http.server.netty.ssl.CertificateProvidedSslBuilder

All Implemented Interfaces:

ApplicationEventListener<RefreshEvent>, Ordered, ServerSslBuilder, RefreshEventListener, EventListener

@Requires(property="micronaut.ssl.enabled",value="true",defaultValue="false") @Requires(property="micronaut.ssl.build-self-signed",value="false",defaultValue="false")
 @Singleton
 @Internal
public class CertificateProvidedSslBuilder
extends SslBuilder<io.netty.handler.ssl.SslContext>
implements ServerSslBuilder, RefreshEventListener, Ordered

The Netty implementation of SslBuilder that generates an SslContext to create a server handle with SSL support via user configuration.

Field Summary

Fields inherited from interface io.micronaut.runtime.context.scope.refresh.RefreshEventListener

DEFAULT_POSITION

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CertificateProvidedSslBuilder(HttpServerConfiguration httpServerConfiguration, ServerSslConfiguration ssl, ResourceResolver resourceResolver)

Method Summary

Modifier and Type	Method and Description
Optional<io.netty.handler.ssl.SslContext>	build()
Optional<io.netty.handler.ssl.SslContext>	build(SslConfiguration ssl)
Optional<io.netty.handler.ssl.SslContext>	build(SslConfiguration ssl, HttpVersion httpVersion)
protected Optional<KeyStore>	getKeyStore(SslConfiguration ssl)
Set<String>	getObservedConfigurationPrefixes() Returns the set of observed configuration prefixes that the event listener should listen for.
int	getOrder()
ServerSslConfiguration	getSslConfiguration()
protected Optional<KeyStore>	getTrustStore(SslConfiguration ssl)
void	onApplicationEvent(RefreshEvent event) Handle an application event.

Methods inherited from class io.micronaut.http.ssl.SslBuilder

getKeyManagerFactory, getTrustManagerFactory, load

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.runtime.context.scope.refresh.RefreshEventListener

supports

Constructor Detail

CertificateProvidedSslBuilder

public CertificateProvidedSslBuilder(HttpServerConfiguration httpServerConfiguration,
                                     ServerSslConfiguration ssl,
                                     ResourceResolver resourceResolver)

Parameters:

httpServerConfiguration - The HTTP server configuration

ssl - The ssl configuration

resourceResolver - The resource resolver

Method Detail

getSslConfiguration

public ServerSslConfiguration getSslConfiguration()

Specified by:

getSslConfiguration in interface ServerSslBuilder

Returns:

The SSL configuration

build

public Optional<io.netty.handler.ssl.SslContext> build()

Specified by:

build in interface ServerSslBuilder

Returns:

Builds the SSL configuration wrapped inside an optional

build

public Optional<io.netty.handler.ssl.SslContext> build(SslConfiguration ssl)

Specified by:

build in class SslBuilder<io.netty.handler.ssl.SslContext>

Parameters:

ssl - The ssl configuration

Returns:

Builds the SSL configuration wrapped inside an optional

build

public Optional<io.netty.handler.ssl.SslContext> build(SslConfiguration ssl,
                                                       HttpVersion httpVersion)

Specified by:

build in class SslBuilder<io.netty.handler.ssl.SslContext>

Parameters:

ssl - The ssl configuration

httpVersion - The http version

Returns:

Builds the SSL configuration wrapped inside an optional

getTrustStore

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

Overrides:

getTrustStore in class SslBuilder<io.netty.handler.ssl.SslContext>

Parameters:

ssl - The ssl configuration

Returns:

An optional KeyStore

Throws:

Exception - if there is an error

getKeyStore

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

Overrides:

getKeyStore in class SslBuilder<io.netty.handler.ssl.SslContext>

Parameters:

ssl - The ssl configuration

Returns:

An optional KeyStore

Throws:

Exception - if there is an error

getObservedConfigurationPrefixes

public Set<String> getObservedConfigurationPrefixes()

Description copied from interface: RefreshEventListener

Returns the set of observed configuration prefixes that the event listener should listen for.

Specified by:

getObservedConfigurationPrefixes in interface RefreshEventListener

Returns:

A set of prefixes

onApplicationEvent

public void onApplicationEvent(RefreshEvent event)

Description copied from interface: ApplicationEventListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationEventListener<RefreshEvent>

Parameters:

event - the event to respond to

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Specified by:

getOrder in interface RefreshEventListener

Returns:

The order of the object. Defaults to zero (no order).