com.crankuptheamps.client

Class TCPSTransport

java.lang.Object

com.crankuptheamps.client.TCPTransport

com.crankuptheamps.client.TCPSTransport

All Implemented Interfaces:

Transport, java.lang.AutoCloseable

public class TCPSTransport
extends TCPTransport

Implements an AMPS transport over SSL. Use this transport by connecting to URIs beginning with tcps://. Use the methods on this class to customize SSL settings prior to connecting.

Field Summary

Fields inherited from class com.crankuptheamps.client.TCPTransport

_impl

Constructor Summary

Constructors

Constructor and Description
TCPSTransport(Protocol msgType)
TCPSTransport(Protocol protocol, java.util.Properties properties)
TCPSTransport(Protocol msgType, TCPSTransportImpl impl)

Method Summary

Modifier and Type	Method and Description
protected TCPSTransportImpl	constructTransportImpl(Protocol protocol, java.util.Properties properties) Constructs a new TCPTransport instance with the specified protocol and properties.
static java.lang.String[]	getDefaultEnabledCipherSuites() Returns the cipher suites that will be enabled on SSLSockets.
static java.lang.String[]	getDefaultEnabledProtocols() Returns the protocols that will be enabled on SSLSockets.
static javax.net.ssl.SSLContext	getDefaultSSLContext() Returns the SSL context that will be used for connecting.
static void	setDefaultEnabledCipherSuites(java.lang.String[] suites) Sets the cipher suites that will be enabled on SSLSockets.
static void	setDefaultEnabledProtocols(java.lang.String[] protocols) Sets the protocols that will be enabled on SSLSockets.
static void	setDefaultSSLContext(javax.net.ssl.SSLContext sslContext) Sets the default SSL Context used for new connections.

Methods inherited from class com.crankuptheamps.client.TCPTransport

allocateMessage, close, connect, createTransport, createTransport, disconnect, flush, flush, getDefaultConnectTimeout, getDefaultReadTimeout, getIdleRunnable, getVersion, handleCloseEvent, initFromClient, isDaemon, readQueueSize, send, sendWithoutRetry, setDaemon, setDefaultConnectTimeout, setDefaultReadTimeout, setDisconnectHandler, setExceptionListener, setIdleRunnable, setMessageHandler, setReadTimeout, setThreadCreatedHandler, setTransportFilter, socket, writeQueueSize

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPSTransport

public TCPSTransport(Protocol protocol,
                     java.util.Properties properties)

TCPSTransport

public TCPSTransport(Protocol msgType)

TCPSTransport

public TCPSTransport(Protocol msgType,
                     TCPSTransportImpl impl)

Method Detail

constructTransportImpl

protected TCPSTransportImpl constructTransportImpl(Protocol protocol,
                                                   java.util.Properties properties)

Description copied from class: TCPTransport

Constructs a new TCPTransport instance with the specified protocol and properties.

Overrides:

constructTransportImpl in class TCPTransport

Parameters:

protocol - The protocol used by the transport.

properties - The properties to configure the transport.

Returns:

A new TCPTransportImpl instance.

setDefaultSSLContext

public static void setDefaultSSLContext(javax.net.ssl.SSLContext sslContext)

Sets the default SSL Context used for new connections.

Parameters:

sslContext - The default SSL context object. This context must be initialized before calling.

getDefaultSSLContext

public static javax.net.ssl.SSLContext getDefaultSSLContext()
                                                     throws java.security.NoSuchAlgorithmException

Returns the SSL context that will be used for connecting.

Returns:

The current default SSL context object.

Throws:

java.security.NoSuchAlgorithmException - Propagates this exception when it is thrown by an attempt to get the default SSLContext.

setDefaultEnabledCipherSuites

public static void setDefaultEnabledCipherSuites(java.lang.String[] suites)

Sets the cipher suites that will be enabled on SSLSockets. This string array will be passed to SSLSocket.setEnabledCipherSuites(java.lang.String[]) whenever a socket is created.

Parameters:

suites - The cipher suites to enable for new sockets.

getDefaultEnabledCipherSuites

public static java.lang.String[] getDefaultEnabledCipherSuites()

Returns the cipher suites that will be enabled on SSLSockets. This function returns null if setDefaultEnabledCipherSuites(java.lang.String[]) has not been called.

Returns:

The cipher suites which will be enabled for new sockets, or null if the virtual machine's defaults will be used.

setDefaultEnabledProtocols

public static void setDefaultEnabledProtocols(java.lang.String[] protocols)

Sets the protocols that will be enabled on SSLSockets. This string array will be passed to SSLSocket.setEnabledProtocols(java.lang.String[]) whenever a socket is created.

Parameters:

protocols - The protocols to enable for new sockets.

getDefaultEnabledProtocols

public static java.lang.String[] getDefaultEnabledProtocols()

Returns the protocols that will be enabled on SSLSockets. This function returns null if setDefaultEnabledProtocols(java.lang.String[]) has not been called.

Returns:

The protocols which will be enabled for new sockets, or null if the virtual machine's defaults will be used.