org.snf4j.core.session.ssl

Class SSLEngineBuilder

java.lang.Object

org.snf4j.core.session.ssl.SSLEngineBuilder

All Implemented Interfaces:

Cloneable

public class SSLEngineBuilder
extends Object
implements Cloneable

A builder for the SSLEngine.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
SSLEngine	build() Builds a new SSLEngine instance based on the current configuration settings.
SSLEngine	build(String peerHost, int peerPort) Builds a new SSLEngine instance based on the current configuration settings and advisory peer information.
SSLEngineBuilder	cipherFilter(CipherFilter filter) Configures a filter for cipher suites to enable, or null to use the default filter.
SSLEngineBuilder	ciphers(String... ciphers) Configures cipher suites to enable, or null to enable the recommended cipher suites.
SSLEngineBuilder	clientAuth(ClientAuth clientAuth) Configures the client authentication mode for a server-side SSLEngine.
SSLEngineBuilder	clone() Generates a new copy of this builder.
SSLContext	context() Returns the SSL context used by the builder to create SSLEngine
SSLEngineBuilder	enableRetransmissions(boolean enable) Configures if DTLS handshake retransmissions should be enabled.
static SSLEngineBuilder	forClient(SSLContext context) Creates a builder for a client-side SSLEngine.
static SSLEngineBuilder	forServer(SSLContext context) Creates a builder for a server-side SSLEngine.
boolean	isForClient() Tells if the builder if for a client-side SSLEngine.
boolean	isForServer() Tells if the builder if for a server-side SSLEngine.
SSLEngineBuilder	maximumPacketSize(int maxSize) Configures the maximum expected network packet size.
SSLEngineBuilder	protocolFilter(ProtocolFilter filter) Configures a filter for protocol versions to enable, or null to use the default filter.
SSLEngineBuilder	protocols(String... protocols) Configures protocol versions to enable, or null to enable the recommended protocol versions.
SSLEngineBuilder	useCiphersOrder(boolean useOrder) Configures if the local cipher suites preferences should be honored during SSL/TLS/DTLS handshaking

Methods inherited from class java.lang.Object

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

Method Detail

forClient

public static SSLEngineBuilder forClient(SSLContext context)

Creates a builder for a client-side SSLEngine.

Parameters:

context - the SSL context used by the builder to create SSLEngine

Returns:

a builder for a client-side SSLEngine

forServer

public static SSLEngineBuilder forServer(SSLContext context)

Creates a builder for a server-side SSLEngine.

Parameters:

context - the SSL context used by the builder to create SSLEngine

Returns:

a builder for a server-side SSLEngine

context

public SSLContext context()

Returns the SSL context used by the builder to create SSLEngine

Returns:

the SSL context

isForServer

public boolean isForServer()

Tells if the builder if for a server-side SSLEngine.

Returns:

true if the builder if for a server-side SSLEngine

isForClient

public boolean isForClient()

Tells if the builder if for a client-side SSLEngine.

Returns:

true if the builder if for a client-side SSLEngine

protocols

public SSLEngineBuilder protocols(String... protocols)

Configures protocol versions to enable, or null to enable the recommended protocol versions.

Parameters:

protocols - the protocol versions

Returns:

this builder

protocolFilter

public SSLEngineBuilder protocolFilter(ProtocolFilter filter)

Configures a filter for protocol versions to enable, or null to use the default filter.

Parameters:

filter - the protocol filter

Returns:

this builder

ciphers

public SSLEngineBuilder ciphers(String... ciphers)

Configures cipher suites to enable, or null to enable the recommended cipher suites.

Parameters:

ciphers - the cipher suites

Returns:

this builder

cipherFilter

public SSLEngineBuilder cipherFilter(CipherFilter filter)

Configures a filter for cipher suites to enable, or null to use the default filter.

Parameters:

filter - the cipher filter

Returns:

this builder

enableRetransmissions

public SSLEngineBuilder enableRetransmissions(boolean enable)

Configures if DTLS handshake retransmissions should be enabled.

NOTE: It requires Java 9 or newer.

Parameters:

enable - true to enable DTLS handshake retransmissions.

Returns:

this builder

maximumPacketSize

public SSLEngineBuilder maximumPacketSize(int maxSize)

Configures the maximum expected network packet size.

NOTE: It requires Java 9 or newer.

Parameters:

maxSize - the maximum expected network packet size in bytes, or 0 to use the default value that is specified by the underlying implementation.

Returns:

this builder

useCiphersOrder

public SSLEngineBuilder useCiphersOrder(boolean useOrder)

Configures if the local cipher suites preferences should be honored during SSL/TLS/DTLS handshaking

Parameters:

useOrder - true to honor the local cipher suites preferences

Returns:

this builder

clientAuth

public SSLEngineBuilder clientAuth(ClientAuth clientAuth)

Configures the client authentication mode for a server-side SSLEngine.

Parameters:

clientAuth - the client authentication mode.

Returns:

this builder

build

public SSLEngine build()
                throws SSLEngineCreateException

Builds a new SSLEngine instance based on the current configuration settings.

Returns:

the new SSLEngine instance.

Throws:

SSLEngineCreateException - if a failure occurred while building the SSLEngine instance

build

public SSLEngine build(String peerHost,
                       int peerPort)
                throws SSLEngineCreateException

Builds a new SSLEngine instance based on the current configuration settings and advisory peer information.

Parameters:

peerHost - the non-authoritative name of the host

peerPort - the non-authoritative port

Returns:

the new SSLEngine instance.

Throws:

SSLEngineCreateException - if a failure occurred while building the SSLEngine instance

See Also:

SSLContext.createSSLEngine(String, int)

clone

public SSLEngineBuilder clone()

Generates a new copy of this builder. Subsequent changes to this builder will not affect the new copy, and vice versa.

Overrides:

clone in class Object