com.adaptris.transport

Class SSLSocketTransport

java.lang.Object

com.adaptris.transport.Transport

com.adaptris.transport.TcpSocketTransport

com.adaptris.transport.SSLSocketTransport

All Implemented Interfaces:

SocketConstants, TransportConstants

public final class SSLSocketTransport
extends TcpSocketTransport

Concrete implementation of Transport.

This implementation will use a JSSE 1.0.2 compliant provider in order to provide the appropriate security and certificate handling.

An attempt is made to add the default JSSE provider com.sun.net.ssl.internal.ssl.Provider() in a static initialisation loop, but no error is logged if this fails (not required under JDK1.4)

This class naturally extends TcpSocketTransport as a secure socket is simply a encryption/decryption layer over the top of a plain socket. Because of this, the configuration for a SSLSocketTransport object is similar to that for a TcpSocketTransport object with a number of additions discussed below

• transport.security.keystore.url The path to the keystore in the as a URL. The url may follow the rules as specified by KeystoreFactory.
• transport.security.keystore.password The password to access the keystore.
• transport.security.keystore.privatekeypassword The private key password
• transport.socket.ssl.always.trust if set to true then AlwaysTrustManager is used to verify the certificate chain sent by the remote party

  The purpose of this private class is to implement a X509TrustManager that always returns true, regardless of the situation.

  Its use is primarily during the test phase, when the Certificate Authority or the certificates themselves have not been agreed upon. It will allow any certificate to be used, ensuring the encryption of the data, but not anything else.

• transport.socket.ssl.require.client.auth if set to true the the client is always required to present a certificate.

More information about SSL/TLS can be found on the internet draft RFC2246. Java Secure Socket Extensions can be found here

See Also:

SocketConstants, TransportConstants, TcpSocketTransport, KeystoreFactory

Field Summary

Fields inherited from class com.adaptris.transport.TcpSocketTransport

config, logR, serverSocket, socketLogger

Fields inherited from interface com.adaptris.transport.SocketConstants

CONFIG_ALWAYS_TRUST, CONFIG_BLOCKSIZE, CONFIG_CLIENT_AUTH, CONFIG_HOST, CONFIG_LISTEN, CONFIG_PORT, CONFIG_TIMEOUT

Fields inherited from interface com.adaptris.transport.TransportConstants

CONFIG_KEYSTORE_FILE, CONFIG_KEYSTORE_PW, CONFIG_PRIVATE_KEY_PW

Constructor Summary

Constructors

Constructor and Description
SSLSocketTransport()

Method Summary

Modifier and Type	Method and Description
TransportLayer	connect() Make a connection.
boolean	getAlwaysTrust() Get the always trust value.
java.lang.String	getKeystorePassword() Get the keystore password
java.lang.String	getKeystoreUrl() Get the keystore path.
java.lang.String	getPrivateKeyPassword() Get the private key password
boolean	getRequireClientAuth() Get the require client authentication flag.
protected void	initFromProperties() Perform initialisation from properties.
TransportLayer	listen(int listenTimeout) Listen for requests.
void	setAlwaysTrust(boolean b) set the AlwaysTrust flag.
void	setKeystorePassword(java.lang.String pw) Set the keystore password.
void	setKeystoreUrl(java.lang.String string) Set the Keystore path
void	setPrivateKeyPassword(java.lang.String pw) Set the private key password * In additional to plain text passwords, the passwords can also be encoded using the appropriate Password
void	setRequireClientAuth(boolean b) Set the require client authentication flag.

Methods inherited from class com.adaptris.transport.TcpSocketTransport

close, getBlockSize, getConnectTimeout, getHost, getListenPort, getPort, listProperties, printSocketInfo, setBlockSize, setConfiguration, setConnectTimeout, setHost, setListenPort, setPort

Methods inherited from class com.adaptris.transport.Transport

create

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLSocketTransport

public SSLSocketTransport()

See Also:

Object.Object()

Method Detail

connect

public TransportLayer connect()
                       throws java.io.InterruptedIOException,
                              TransportException,
                              java.lang.IllegalStateException

Description copied from class: Transport

Make a connection.

If this has to negotiate an X.25 pad, then this is where that happens.

The point where this method should return is when the connection has been made to the remote server, but before any actual transport protocol negotiation, other than that required to make the connection has occurred e.g. there is a connection to the remote server, but the OFTP SSRM has not yet been received.

Overrides:

connect in class TcpSocketTransport

Returns:

an object capable of sending and receiving data

Throws:

java.io.InterruptedIOException - If the attempt to connect exceeded the timeout

TransportException - Any other Exception

java.lang.IllegalStateException - If this TransportLayer object can't make a client connection because it doesn't know how to

See Also:

Transport.connect()

listen

public TransportLayer listen(int listenTimeout)
                      throws TransportException,
                             java.lang.IllegalStateException,
                             java.io.InterruptedIOException

Description copied from class: Transport

Listen for requests.

The method should block until timeout or until a request is received and accepted.

The point where this method should return is when the connection has been made to the remote server, but before any actual transport protocol negotiation, other than that required to make the connection has occurred. e.g. The remote party is connected, but this server has not yet sent the OFTP SSRM.

Overrides:

listen in class TcpSocketTransport

Parameters:

listenTimeout - how long to listen for (ms)

Returns:

an object capable of sending and receiving.

Throws:

TransportException - Any other Exception

java.lang.IllegalStateException - If this TransportLayer object can't listen because it doesn't know how to

java.io.InterruptedIOException - if the attempt to listen has exceeded the listenTimeout

See Also:

Transport.listen(int)

getAlwaysTrust

public boolean getAlwaysTrust()

Get the always trust value.

Returns:

the always trust flag.

getKeystorePassword

public java.lang.String getKeystorePassword()

Get the keystore password

Returns:

the kesytore password

getKeystoreUrl

public java.lang.String getKeystoreUrl()

Get the keystore path.

Returns:

the keystore path

getPrivateKeyPassword

public java.lang.String getPrivateKeyPassword()

Get the private key password

Returns:

the private key password

getRequireClientAuth

public boolean getRequireClientAuth()

Get the require client authentication flag.

Returns:

the flag.

setAlwaysTrust

public void setAlwaysTrust(boolean b)

set the AlwaysTrust flag.

Parameters:

b - true or false.

setKeystorePassword

public void setKeystorePassword(java.lang.String pw)

Set the keystore password.

In additional to plain text passwords, the passwords can also be encoded using the appropriate Password

Parameters:

pw - the password, defaults to null as the password may be embedded in setKeystoreUrl(String)

setKeystoreUrl

public void setKeystoreUrl(java.lang.String string)

Set the Keystore path

Parameters:

string - the path

setPrivateKeyPassword

public void setPrivateKeyPassword(java.lang.String pw)

Set the private key password *

In additional to plain text passwords, the passwords can also be encoded using the appropriate Password

Parameters:

pw - the password

setRequireClientAuth

public void setRequireClientAuth(boolean b)

Set the require client authentication flag.

Parameters:

b - true or false

initFromProperties

protected void initFromProperties()
                           throws TransportException

Description copied from class: TcpSocketTransport

Perform initialisation from properties.

Overrides:

initFromProperties in class TcpSocketTransport

Throws:

TransportException - on error.

See Also:

TcpSocketTransport.initFromProperties()