org.apache.qpid.jms.transports

Class TransportSslOptions

java.lang.Object

org.apache.qpid.jms.transports.TransportOptions

org.apache.qpid.jms.transports.TransportSslOptions

public class TransportSslOptions
extends TransportOptions

Holds the defined SSL options for connections that operate over a secure transport. Options are read from the environment and can be overridden by specifying them on the connection URI.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTEXT_PROTOCOL
static List<String>	DEFAULT_DISABLED_PROTOCOLS
static int	DEFAULT_SSL_PORT
static String	DEFAULT_STORE_TYPE
static boolean	DEFAULT_TRUST_ALL
static boolean	DEFAULT_VERIFY_HOST
static TransportSslOptions	INSTANCE

Fields inherited from class org.apache.qpid.jms.transports.TransportOptions

DEFAULT_CONNECT_TIMEOUT, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_SO_LINGER, DEFAULT_SO_TIMEOUT, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_PORT, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor and Description
TransportSslOptions()

Method Summary

Methods

Modifier and Type	Method and Description
TransportSslOptions	clone()
protected TransportSslOptions	copyOptions(TransportSslOptions copy)
String	getContextProtocol()
int	getDefaultSslPort()
String[]	getDisabledCipherSuites()
String[]	getDisabledProtocols()
String[]	getEnabledCipherSuites()
String[]	getEnabledProtocols()
String	getKeyAlias()
String	getKeyStoreLocation()
String	getKeyStorePassword()
String	getStoreType()
String	getTrustStoreLocation()
String	getTrustStorePassword()
boolean	isTrustAll()
boolean	isVerifyHost()
void	setContextProtocol(String contextProtocol) The protocol value to use when creating an SSLContext via SSLContext.getInstance(protocol).
void	setDefaultSslPort(int defaultSslPort)
void	setDisabledCipherSuites(String[] disabledCipherSuites)
void	setDisabledProtocols(String[] disabledProtocols) The protocols to be disable.
void	setEnabledCipherSuites(String[] enabledCipherSuites)
void	setEnabledProtocols(String[] enabledProtocols) The protocols to be set as enabled.
void	setKeyAlias(String keyAlias)
void	setKeyStoreLocation(String keyStoreLocation) Sets the location on disk of the key store to use.
void	setKeyStorePassword(String keyStorePassword)
void	setStoreType(String storeType)
void	setTrustAll(boolean trustAll)
void	setTrustStoreLocation(String trustStoreLocation)
void	setTrustStorePassword(String trustStorePassword)
void	setVerifyHost(boolean verifyHost)

Methods inherited from class org.apache.qpid.jms.transports.TransportOptions

copyOptions, getConnectTimeout, getDefaultTcpPort, getReceiveBufferSize, getSendBufferSize, getSoLinger, getSoTimeout, getTrafficClass, isTcpKeepAlive, isTcpNoDelay, setConnectTimeout, setDefaultTcpPort, setReceiveBufferSize, setSendBufferSize, setSoLinger, setSoTimeout, setTcpKeepAlive, setTcpNoDelay, setTrafficClass

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STORE_TYPE

public static final String DEFAULT_STORE_TYPE

See Also:

Constant Field Values

DEFAULT_CONTEXT_PROTOCOL

public static final String DEFAULT_CONTEXT_PROTOCOL

See Also:

Constant Field Values

DEFAULT_TRUST_ALL

public static final boolean DEFAULT_TRUST_ALL

See Also:

Constant Field Values

DEFAULT_VERIFY_HOST

public static final boolean DEFAULT_VERIFY_HOST

See Also:

Constant Field Values

DEFAULT_DISABLED_PROTOCOLS

public static final List<String> DEFAULT_DISABLED_PROTOCOLS

DEFAULT_SSL_PORT

public static final int DEFAULT_SSL_PORT

See Also:

Constant Field Values

INSTANCE

public static final TransportSslOptions INSTANCE

Constructor Detail

TransportSslOptions

public TransportSslOptions()

Method Detail

getKeyStoreLocation

public String getKeyStoreLocation()

Returns:

the keyStoreLocation currently configured.

setKeyStoreLocation

public void setKeyStoreLocation(String keyStoreLocation)

Sets the location on disk of the key store to use.

Parameters:

keyStoreLocation - the keyStoreLocation to use to create the key manager.

getKeyStorePassword

public String getKeyStorePassword()

Returns:

the keyStorePassword

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

Parameters:

keyStorePassword - the keyStorePassword to set

getTrustStoreLocation

public String getTrustStoreLocation()

Returns:

the trustStoreLocation

setTrustStoreLocation

public void setTrustStoreLocation(String trustStoreLocation)

Parameters:

trustStoreLocation - the trustStoreLocation to set

getTrustStorePassword

public String getTrustStorePassword()

Returns:

the trustStorePassword

setTrustStorePassword

public void setTrustStorePassword(String trustStorePassword)

Parameters:

trustStorePassword - the trustStorePassword to set

getStoreType

public String getStoreType()

Returns:

the storeType

setStoreType

public void setStoreType(String storeType)

Parameters:

storeType - the format that the store files are encoded in.

getEnabledCipherSuites

public String[] getEnabledCipherSuites()

Returns:

the enabledCipherSuites

setEnabledCipherSuites

public void setEnabledCipherSuites(String[] enabledCipherSuites)

Parameters:

enabledCipherSuites - the enabledCipherSuites to set

getDisabledCipherSuites

public String[] getDisabledCipherSuites()

Returns:

the disabledCipherSuites

setDisabledCipherSuites

public void setDisabledCipherSuites(String[] disabledCipherSuites)

Parameters:

disabledCipherSuites - the disabledCipherSuites to set

getEnabledProtocols

public String[] getEnabledProtocols()

Returns:

the enabledProtocols or null if the defaults should be used

setEnabledProtocols

public void setEnabledProtocols(String[] enabledProtocols)

The protocols to be set as enabled.

Parameters:

enabledProtocols - the enabled protocols to set, or null if the defaults should be used.

getDisabledProtocols

public String[] getDisabledProtocols()

Returns:

the protocols to disable or null if none should be

setDisabledProtocols

public void setDisabledProtocols(String[] disabledProtocols)

The protocols to be disable.

Parameters:

disabledProtocols - the protocols to disable, or null if none should be.

getContextProtocol

public String getContextProtocol()

Returns:

the context protocol to use

setContextProtocol

public void setContextProtocol(String contextProtocol)

The protocol value to use when creating an SSLContext via SSLContext.getInstance(protocol).

Parameters:

contextProtocol - the context protocol to use.

isTrustAll

public boolean isTrustAll()

Returns:

the trustAll

setTrustAll

public void setTrustAll(boolean trustAll)

Parameters:

trustAll - the trustAll to set

isVerifyHost

public boolean isVerifyHost()

Returns:

the verifyHost

setVerifyHost

public void setVerifyHost(boolean verifyHost)

Parameters:

verifyHost - the verifyHost to set

getKeyAlias

public String getKeyAlias()

Returns:

the key alias

setKeyAlias

public void setKeyAlias(String keyAlias)

Parameters:

keyAlias - the key alias to use

getDefaultSslPort

public int getDefaultSslPort()

setDefaultSslPort

public void setDefaultSslPort(int defaultSslPort)

clone

public TransportSslOptions clone()

Overrides:

clone in class TransportOptions

copyOptions

protected TransportSslOptions copyOptions(TransportSslOptions copy)