org.apache.activemq.transport.tcp: public class: SslTransport

org.apache.activemq.transport.tcp
public class: SslTransport [javadoc | source]

java.lang.Object
   org.apache.activemq.util.ServiceSupport
      org.apache.activemq.transport.TransportSupport
         org.apache.activemq.transport.TransportThreadSupport
            org.apache.activemq.transport.tcp.TcpTransport
               org.apache.activemq.transport.tcp.SslTransport

All Implemented Interfaces:
Service, Transport, Runnable

A Transport class that uses SSL and client-side certificate authentication. Client-side certificate authentication must be enabled through the constructor. By default, this class will have the same client authentication behavior as the socket it is passed. This class will set ConnectionInfo's transportContext to the SSL certificates of the client. NOTE: Accessor method for needClientAuth was not provided on purpose. This is because needClientAuth's value must be set before the socket is connected. Otherwise, unexpected situations may occur.

Fields inherited from org.apache.activemq.transport.tcp.TcpTransport:
remoteLocation, localLocation, wireFormat, connectionTimeout, soTimeout, socketBufferSize, ioBufferSize, closeAsync, socket, dataOut, dataIn, buffOut, trace, logWriterName, dynamicManagement, startLogging, jmxPort, useLocalHost, minmumWireFormatVersion, socketFactory, stoppedLatch

Fields inherited from org.apache.activemq.transport.TransportSupport:
transportListener

Constructor:

Constructor:
public SslTransport(WireFormat wireFormat, SSLSocket socket) throws IOException { super(wireFormat, socket); } Initialize from a ServerSocket. No access to needClientAuth is given since it is already set within the provided socket. Parameters: `wireFormat` - The WireFormat to be used. `socket` - The Socket to be used. Forcing SSL. Throws: `IOException` - If TcpTransport throws.
public SslTransport(WireFormat wireFormat, SSLSocketFactory socketFactory, URI remoteLocation, URI localLocation, boolean needClientAuth) throws IOException { super(wireFormat, socketFactory, remoteLocation, localLocation); if (this.socket != null) { ((SSLSocket)this.socket).setNeedClientAuth(needClientAuth); } } Connect to a remote node such as a Broker. Parameters: `wireFormat` - The WireFormat to be used. `socketFactory` - The socket factory to be used. Forcing SSLSockets for obvious reasons. `remoteLocation` - The remote location. `localLocation` - The local location. `needClientAuth` - If set to true, the underlying socket will need client certificate authentication. Throws: `UnknownHostException` - If TcpTransport throws. `IOException` - If TcpTransport throws.

 public SslTransport(WireFormat wireFormat,
    SSLSocket socket) throws IOException {
        super(wireFormat, socket);
}

Initialize from a ServerSocket. No access to needClientAuth is given since it is already set within the provided socket.

Parameters:

wireFormat - The WireFormat to be used.

socket - The Socket to be used. Forcing SSL.

Throws:

IOException - If TcpTransport throws.

 public SslTransport(WireFormat wireFormat,
    SSLSocketFactory socketFactory,
    URI remoteLocation,
    URI localLocation,
    boolean needClientAuth) throws IOException {
        super(wireFormat, socketFactory, remoteLocation, localLocation);
        if (this.socket != null) {
            ((SSLSocket)this.socket).setNeedClientAuth(needClientAuth);
        }
}

Connect to a remote node such as a Broker.

Parameters:

wireFormat - The WireFormat to be used.

socketFactory - The socket factory to be used. Forcing SSLSockets for obvious reasons.

remoteLocation - The remote location.

localLocation - The local location.

needClientAuth - If set to true, the underlying socket will need client certificate authentication.

Throws:

UnknownHostException - If TcpTransport throws.

IOException - If TcpTransport throws.

Method from org.apache.activemq.transport.tcp.SslTransport Summary:
doConsume, getPeerCertificates, toString

Methods from org.apache.activemq.transport.tcp.TcpTransport:
closeStreams, connect, doRun, doStart, doStop, getConnectionTimeout, getIoBufferSize, getJmxPort, getKeepAlive, getLogWriterName, getMinmumWireFormatVersion, getReceiveCounter, getRemoteAddress, getSoTimeout, getSocketBufferSize, getTcpNoDelay, initialiseSocket, initializeStreams, isCloseAsync, isDynamicManagement, isStartLogging, isTrace, isUseLocalHost, narrow, oneway, readCommand, resolveHostName, run, setCloseAsync, setConnectionTimeout, setDynamicManagement, setIoBufferSize, setJmxPort, setKeepAlive, setLogWriterName, setMinmumWireFormatVersion, setSoTimeout, setSocketBufferSize, setSocketOptions, setStartLogging, setTcpNoDelay, setTrace, setUseLocalHost, stop, toString

Methods from org.apache.activemq.transport.tcp.TcpTransport:

closeStreams, connect, doRun, doStart, doStop, getConnectionTimeout, getIoBufferSize, getJmxPort, getKeepAlive, getLogWriterName, getMinmumWireFormatVersion, getReceiveCounter, getRemoteAddress, getSoTimeout, getSocketBufferSize, getTcpNoDelay, initialiseSocket, initializeStreams, isCloseAsync, isDynamicManagement, isStartLogging, isTrace, isUseLocalHost, narrow, oneway, readCommand, resolveHostName, run, setCloseAsync, setConnectionTimeout, setDynamicManagement, setIoBufferSize, setJmxPort, setKeepAlive, setLogWriterName, setMinmumWireFormatVersion, setSoTimeout, setSocketBufferSize, setSocketOptions, setStartLogging, setTcpNoDelay, setTrace, setUseLocalHost, stop, toString

Methods from org.apache.activemq.transport.TransportThreadSupport:
doStart, getStackSize, isDaemon, setDaemon, setStackSize

Methods from org.apache.activemq.transport.TransportSupport:
asyncRequest, checkStarted, doConsume, getTransportListener, isConnected, isDisposed, isFaultTolerant, narrow, onException, reconnect, request, request, setTransportListener

Methods from org.apache.activemq.util.ServiceSupport:
addServiceListener, dispose, doStart, doStop, isStarted, isStopped, isStopping, removeServiceListener, start, stop

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.activemq.transport.tcp.SslTransport Detail:
public void doConsume(Object command) { // The instanceof can be avoided, but that would require modifying the // Command clas tree and that would require too much effort right // now. if (command instanceof ConnectionInfo) { ConnectionInfo connectionInfo = (ConnectionInfo)command; connectionInfo.setTransportContext(getPeerCertificates()); } super.doConsume(command); } Overriding in order to add the client's certificates to ConnectionInfo Commmands.
public X509Certificate[] getPeerCertificates() { SSLSocket sslSocket = (SSLSocket)this.socket; SSLSession sslSession = sslSocket.getSession(); X509Certificate[] clientCertChain; try { clientCertChain = (X509Certificate[])sslSession.getPeerCertificates(); } catch (SSLPeerUnverifiedException e) { clientCertChain = null; } return clientCertChain; }
public String toString() { return "ssl://" + socket.getInetAddress() + ":" + socket.getPort(); }

Method from org.apache.activemq.transport.tcp.SslTransport Detail:

 public  void doConsume(Object command) {
        // The instanceof can be avoided, but that would require modifying the
        // Command clas tree and that would require too much effort right
        // now.
        if (command instanceof ConnectionInfo) {
            ConnectionInfo connectionInfo = (ConnectionInfo)command;
            connectionInfo.setTransportContext(getPeerCertificates());
        } 
        super.doConsume(command);
}

Overriding in order to add the client's certificates to ConnectionInfo Commmands.

 public X509Certificate[] getPeerCertificates() {
    	
        SSLSocket sslSocket = (SSLSocket)this.socket;
        SSLSession sslSession = sslSocket.getSession();
        X509Certificate[] clientCertChain;
        try {
            clientCertChain = (X509Certificate[])sslSession.getPeerCertificates();
        } catch (SSLPeerUnverifiedException e) {
        	clientCertChain = null;
        }
        return clientCertChain;
}

 public String toString() {
        return "ssl://" + socket.getInetAddress() + ":" + socket.getPort();
}