Module swim.io

Package swim.io

Class TlsSettings

java.lang.Object

swim.io.TlsSettings

All Implemented Interfaces:

Debug

public class TlsSettings
extends Object
implements Debug

TLS configuration parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	cipherSuites
protected ClientAuth	clientAuth
protected Collection<String>	protocols
protected SSLContext	sslContext

Constructor Summary

Constructors

Constructor	Description
TlsSettings(SSLContext sslContext, ClientAuth clientAuth, Collection<String> cipherSuites, Collection<String> protocols)

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(Object other)	Returns true if these TlsSettings can possibly equal some other object.
Collection<String>	cipherSuites()	Returns the set of permitted cipher suites for secure socket connections, or null if the system defaults should be used.
TlsSettings	cipherSuites(Collection<String> cipherSuites)	Returns a copy of these TlsSettings configured with the given set of cipherSuites; cipherSuites may be null if the system defaults should be used.
ClientAuth	clientAuth()	Returns the authentication requirement for incoming connections.
TlsSettings	clientAuth(ClientAuth clientAuth)	Returns a copy of these TlsSettings configured with the given clientAuth authentication requirement for incoming connections.
protected TlsSettings	copy(SSLContext sslContext, ClientAuth clientAuth, Collection<String> cipherSuites, Collection<String> protocols)	Returns a new TlsSettings instance with the given options.
static TlsSettings	create(ClientAuth clientAuth, Collection<String> cipherSuites, Collection<String> protocols)
<T> Output<T>	debug(Output<T> output)	Writes a developer readable, debug-formatted string representation of this object to output.
boolean	equals(Object other)
static Form<TlsSettings>	form()	Returns the structural Form of TlsSettings.
int	hashCode()
Collection<String>	protocols()	Returns the set of permitted secure socket layer protocols, or null if the system defaults should be used.
TlsSettings	protocols(Collection<String> protocols)	Returns a copy of these TlsSettings configured with the given set of protocols; protocols may be null if the system defaults should be used.
SSLContext	sslContext()	Returns the factory used to create secure sockets.
TlsSettings	sslContext(SSLContext sslContext)	Returns a copy of these TlsSettings configured with the given sslContext for creating secure sockets.
static TlsSettings	standard()	Returns the default TlsSettings instance.
String	toString()
Value	toValue()	Returns a structural Value representing these TlsSettings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sslContext

protected final SSLContext sslContext

clientAuth

protected final ClientAuth clientAuth

cipherSuites

protected final Collection<String> cipherSuites

protocols

protected final Collection<String> protocols

Constructor Detail

TlsSettings

public TlsSettings(SSLContext sslContext,
                   ClientAuth clientAuth,
                   Collection<String> cipherSuites,
                   Collection<String> protocols)

Method Detail

sslContext

public final SSLContext sslContext()

Returns the factory used to create secure sockets.

sslContext

public TlsSettings sslContext(SSLContext sslContext)

Returns a copy of these TlsSettings configured with the given sslContext for creating secure sockets.

clientAuth

public final ClientAuth clientAuth()

Returns the authentication requirement for incoming connections.

clientAuth

public TlsSettings clientAuth(ClientAuth clientAuth)

Returns a copy of these TlsSettings configured with the given clientAuth authentication requirement for incoming connections.

cipherSuites

public final Collection<String> cipherSuites()

Returns the set of permitted cipher suites for secure socket connections, or null if the system defaults should be used.

cipherSuites

public TlsSettings cipherSuites(Collection<String> cipherSuites)

Returns a copy of these TlsSettings configured with the given set of cipherSuites; cipherSuites may be null if the system defaults should be used.

protocols

public final Collection<String> protocols()

Returns the set of permitted secure socket layer protocols, or null if the system defaults should be used.

protocols

public TlsSettings protocols(Collection<String> protocols)

Returns a copy of these TlsSettings configured with the given set of protocols; protocols may be null if the system defaults should be used.

copy

protected TlsSettings copy(SSLContext sslContext,
                           ClientAuth clientAuth,
                           Collection<String> cipherSuites,
                           Collection<String> protocols)

Returns a new TlsSettings instance with the given options. Subclasses may override this method to ensure the proper class is instantiated when updating settings.

toValue

public Value toValue()

Returns a structural Value representing these TlsSettings.

canEqual

public boolean canEqual(Object other)

Returns true if these TlsSettings can possibly equal some other object.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

debug

public <T> Output<T> debug(Output<T> output)

Description copied from interface: Debug

Writes a developer readable, debug-formatted string representation of this object to output.

Specified by:

debug in interface Debug

Returns:

the continuation of the output.

toString

public String toString()

Overrides:

toString in class Object

standard

public static TlsSettings standard()

Returns the default TlsSettings instance.

create

public static TlsSettings create(ClientAuth clientAuth,
                                 Collection<String> cipherSuites,
                                 Collection<String> protocols)

form

@Kind
public static Form<TlsSettings> form()

Returns the structural Form of TlsSettings.