Package org.forgerock.openig.tools

Class ClientTlsOptions

java.lang.Object

org.forgerock.openig.tools.ClientTlsOptions

Direct Known Subclasses:

ServerTlsOptions

public class ClientTlsOptions
extends Object

TLS Options value object.

Constructor Summary

Constructors

Constructor	Description
ClientTlsOptions(String algorithm, KeyManager[] managers, TrustManager[] trustManagers, List<String> ciphers, List<String> protocols, boolean enableAlpn)	Constructs TLS options with provided values.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Returns the SSL context algorithm name (never null).
String[]	getCipherSuitesArray()	Returns the array of cipher suites to be enabled (may be null for JVM default).
List<String>	getCipherSuitesList()	Returns the list of cipher suites to be enabled (may be empty for JVM default).
String[]	getEnabledProtocolsArray()	Returns the array of protocols to be enabled (may be null for JVM default).
List<String>	getEnabledProtocolsList()	Returns the list of protocols to be enabled (may be empty for JVM default).
KeyManager[]	getKeyManagers()	Returns the array of KeyManager to use (may be null).
TrustManager[]	getTrustManagers()	Returns the array of TrustManager to use (may be null).
boolean	isAlpnEnabled()	Is ALPN (Application Layer Protocol Negotiation, a TLS extension) enabled or not ?

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTlsOptions

public ClientTlsOptions(String algorithm,
                        KeyManager[] managers,
                        TrustManager[] trustManagers,
                        List<String> ciphers,
                        List<String> protocols,
                        boolean enableAlpn)

Constructs TLS options with provided values.

Parameters:

algorithm - SSL algorithm (not null)

managers - array of KeyManager (may be null)

trustManagers - array of TrustManager (may be null)

ciphers - list of cipher suites to be enabled (may be empty for JVM default)

protocols - list of protocols to be enabled (may be empty for JVM default)

enableAlpn - enable the ALPN TLS extension

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the SSL context algorithm name (never null).

Returns:

the SSL context algorithm name (never null).

getKeyManagers

public KeyManager[] getKeyManagers()

Returns the array of KeyManager to use (may be null).

Returns:

the array of KeyManager to use (may be null).

getTrustManagers

public TrustManager[] getTrustManagers()

Returns the array of TrustManager to use (may be null).

Returns:

the array of TrustManager to use (may be null).

getCipherSuitesArray

public String[] getCipherSuitesArray()

Returns the array of cipher suites to be enabled (may be null for JVM default).

Returns:

the array of cipher suites to be enabled (may be null for JVM default).

getCipherSuitesList

public List<String> getCipherSuitesList()

Returns the list of cipher suites to be enabled (may be empty for JVM default).

Returns:

the list of cipher suites to be enabled (may be empty for JVM default).

getEnabledProtocolsArray

public String[] getEnabledProtocolsArray()

Returns the array of protocols to be enabled (may be null for JVM default).

Returns:

the array of protocols to be enabled (may be null for JVM default).

getEnabledProtocolsList

public List<String> getEnabledProtocolsList()

Returns the list of protocols to be enabled (may be empty for JVM default).

Returns:

the list of protocols to be enabled (may be empty for JVM default).

isAlpnEnabled

public boolean isAlpnEnabled()

Is ALPN (Application Layer Protocol Negotiation, a TLS extension) enabled or not ?

Returns:

true if the ALPN is enabled, false otherwise.