IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.clientserver
Interface SSLEnabler


public interface SSLEnabler

This interface enables the CSClientService to make use of JSSE to get secure connections.

The interface relies on the generic classes provided by JSSE. Implementors of SSLEnabler will make use of a given implementation of JSSE.


Field Summary
static java.lang.String CLIENTAUTHENTICATION
           
static java.lang.String CLIENTKEYPAIRFILE
           
static java.lang.String CLIENTKEYPAIRPATH
           
static java.lang.String CLIENTKEYPAIRPW
           
static java.lang.String COPYRIGHT
           
static java.lang.String defaultSSLVersion
           
static java.lang.String ENABLEDCIPHERSUITES
           
static java.lang.String FROMJAR
           
static java.lang.String JSSE
           
static java.lang.String KEYSTORETYPE
           
static java.lang.String SRVPUBLICKEYFILE
           
static java.lang.String SRVPUBLICKEYPATH
           
static java.lang.String SRVPUBLICKEYPW
           
static java.lang.String SSL010
           
static java.lang.String SSL011
           
static java.lang.String SSL012
           
static java.lang.String SSL013
           
static java.lang.String SSLv2
           
static java.lang.String SSLv3
           
static java.lang.String SSLVERSION
           
static java.lang.String TLS
           
static java.lang.String TRUSTALGORITHM
           
 
Method Summary
 boolean getClientAuthentication()
          Gets the clientAuthentication.
 java.lang.String getClientKeyPairFile()
          Gets the clientKeyPairFile.
 java.lang.String getClientKeyPairPath()
          Gets the clientKeyPairPath.
 java.lang.String getClientKeyPairPw()
          Gets the clientKeyPairPw.
 java.lang.String[] getEnabledCipherSuites()
          Returns the enabledCipherSuites.
 boolean getEnableSSL()
          Gets the enableSSL.
 java.lang.String getKeyStoreType()
          Gets the keyStoreType.
 java.lang.String getSrvPublicKeyFile()
          Returns the srvPublicKeyFile.
 java.lang.String getSrvPublicKeyPath()
          Returns the srvPublicKeyPath.
 java.lang.String getSrvPublicKeyPw()
          Gets the srvPublicKeyPw.
 javax.net.ssl.SSLSocketFactory getSSLfactory()
          Gets the sslfactory.
 java.net.Socket getSSLSocket(java.lang.String host, int port)
          Returns a secure socket.
 java.lang.String getSSLVersion()
          Gets the sslVersion.
 java.lang.String getTrustAlgorithm()
          Gets the trustAlgorithm.
 void initializeSSL(java.lang.String csClientPath)
          Initializes the SSL environment.
 void setClientAuthentication(boolean clientAuthentication)
          Sets the clientAuthentication.
 void setClientKeyPairFile(java.lang.String clientKeyPairFile)
          Sets the clientKeyPairFile.
 void setClientKeyPairPath(java.lang.String clientKeyPairPath)
          Sets the clientKeyPairPath.
 void setClientKeyPairPw(java.lang.String clientKeyPairPw)
          Sets the clientKeyPairPw.
 void setEnabledCipherSuites(java.lang.String[] enabledCipherSuites)
          Sets the enabledCipherSuites.
 void setEnableSSL(boolean enableSSL)
          Sets the enableSSL.
 void setKeyStoreType(java.lang.String keyStoreType)
          Sets the keyStoreType.
 void setSrvPublicKeyFile(java.lang.String srvPublicKeyFile)
          Sets the srvPublicKeyFile.
 void setSrvPublicKeyPath(java.lang.String srvPublicKeyPath)
          Sets the srvPublicKeyPath.
 void setSrvPublicKeyPw(java.lang.String srvPublicKeyPw)
          Sets the srvPublicKeyPw.
 void setSSLfactory(javax.net.ssl.SSLSocketFactory sslfactory)
          Sets the sslfactory.
 void setSSLVersion(java.lang.String sslVersion)
          Sets the sslVersion.
 void setTrustAlgorithm(java.lang.String trustAlgorithm)
          Sets the trustAlgorithm.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

KEYSTORETYPE

static final java.lang.String KEYSTORETYPE
See Also:
Constant Field Values

SRVPUBLICKEYPATH

static final java.lang.String SRVPUBLICKEYPATH
See Also:
Constant Field Values

SRVPUBLICKEYFILE

static final java.lang.String SRVPUBLICKEYFILE
See Also:
Constant Field Values

SRVPUBLICKEYPW

static final java.lang.String SRVPUBLICKEYPW
See Also:
Constant Field Values

TRUSTALGORITHM

static final java.lang.String TRUSTALGORITHM
See Also:
Constant Field Values

CLIENTAUTHENTICATION

static final java.lang.String CLIENTAUTHENTICATION
See Also:
Constant Field Values

CLIENTKEYPAIRPATH

static final java.lang.String CLIENTKEYPAIRPATH
See Also:
Constant Field Values

CLIENTKEYPAIRFILE

static final java.lang.String CLIENTKEYPAIRFILE
See Also:
Constant Field Values

CLIENTKEYPAIRPW

static final java.lang.String CLIENTKEYPAIRPW
See Also:
Constant Field Values

SSLVERSION

static final java.lang.String SSLVERSION
See Also:
Constant Field Values

ENABLEDCIPHERSUITES

static final java.lang.String ENABLEDCIPHERSUITES
See Also:
Constant Field Values

FROMJAR

static final java.lang.String FROMJAR
See Also:
Constant Field Values

SSLv2

static final java.lang.String SSLv2
See Also:
Constant Field Values

SSLv3

static final java.lang.String SSLv3
See Also:
Constant Field Values

TLS

static final java.lang.String TLS
See Also:
Constant Field Values

defaultSSLVersion

static final java.lang.String defaultSSLVersion
See Also:
Constant Field Values

SSL010

static final java.lang.String SSL010
See Also:
Constant Field Values

SSL011

static final java.lang.String SSL011
See Also:
Constant Field Values

SSL012

static final java.lang.String SSL012
See Also:
Constant Field Values

SSL013

static final java.lang.String SSL013
See Also:
Constant Field Values

JSSE

static final java.lang.String JSSE
See Also:
Constant Field Values
Method Detail

getSrvPublicKeyFile

java.lang.String getSrvPublicKeyFile()
Returns the srvPublicKeyFile.

Returns:
String

setSrvPublicKeyFile

void setSrvPublicKeyFile(java.lang.String srvPublicKeyFile)
Sets the srvPublicKeyFile.

Parameters:
srvPublicKeyFile - - The srvPublicKeyFile to set

getSrvPublicKeyPath

java.lang.String getSrvPublicKeyPath()
Returns the srvPublicKeyPath.

Returns:
String

setSrvPublicKeyPath

void setSrvPublicKeyPath(java.lang.String srvPublicKeyPath)
Sets the srvPublicKeyPath.

Parameters:
srvPublicKeyPath - - The srvPublicKeyPath to set

getSrvPublicKeyPw

java.lang.String getSrvPublicKeyPw()
Gets the srvPublicKeyPw.

Returns:
Returns a String

setSrvPublicKeyPw

void setSrvPublicKeyPw(java.lang.String srvPublicKeyPw)
Sets the srvPublicKeyPw.

Parameters:
srvPublicKeyPw - - The srvPublicKeyPw to set

getClientKeyPairPath

java.lang.String getClientKeyPairPath()
Gets the clientKeyPairPath.

Returns:
Returns a String

setClientKeyPairPath

void setClientKeyPairPath(java.lang.String clientKeyPairPath)
Sets the clientKeyPairPath.

Parameters:
clientKeyPairPath - - The clientKeyPairPath to set

getClientKeyPairFile

java.lang.String getClientKeyPairFile()
Gets the clientKeyPairFile.

Returns:
Returns a String

setClientKeyPairFile

void setClientKeyPairFile(java.lang.String clientKeyPairFile)
Sets the clientKeyPairFile.

Parameters:
clientKeyPairFile - - The clientKeyPairFile to set

getClientKeyPairPw

java.lang.String getClientKeyPairPw()
Gets the clientKeyPairPw.

Returns:
Returns a String

setClientKeyPairPw

void setClientKeyPairPw(java.lang.String clientKeyPairPw)
Sets the clientKeyPairPw.

Parameters:
clientKeyPairPw - - The clientKeyPairPw to set

getSSLVersion

java.lang.String getSSLVersion()
Gets the sslVersion.

Returns:
Returns a String

setSSLVersion

void setSSLVersion(java.lang.String sslVersion)
Sets the sslVersion.

Parameters:
sslVersion - - The sslVersion to set

getSSLfactory

javax.net.ssl.SSLSocketFactory getSSLfactory()
Gets the sslfactory.

Returns:
Returns a javax.net.ssl.SSLSocketFactory

setSSLfactory

void setSSLfactory(javax.net.ssl.SSLSocketFactory sslfactory)
Sets the sslfactory.

Parameters:
sslfactory - - The sslfactory to set

getTrustAlgorithm

java.lang.String getTrustAlgorithm()
Gets the trustAlgorithm.

Returns:
Returns a String

setTrustAlgorithm

void setTrustAlgorithm(java.lang.String trustAlgorithm)
Sets the trustAlgorithm.

Parameters:
trustAlgorithm - - The trustAlgorithm to set

getKeyStoreType

java.lang.String getKeyStoreType()
Gets the keyStoreType.

Returns:
Returns a String

setKeyStoreType

void setKeyStoreType(java.lang.String keyStoreType)
Sets the keyStoreType.

Parameters:
keyStoreType - - The keyStoreType to set

getEnableSSL

boolean getEnableSSL()
Gets the enableSSL.

Returns:
Returns a boolean

setEnableSSL

void setEnableSSL(boolean enableSSL)
Sets the enableSSL.

Parameters:
enableSSL - - The enableSSL to set

getClientAuthentication

boolean getClientAuthentication()
Gets the clientAuthentication.

Returns:
Returns a boolean

setClientAuthentication

void setClientAuthentication(boolean clientAuthentication)
Sets the clientAuthentication.

Parameters:
clientAuthentication - - The clientAuthentication to set

initializeSSL

void initializeSSL(java.lang.String csClientPath)
                   throws DSECSSSLException
Initializes the SSL environment. Reads the externalized data concerning the SSL implementation and creates an SSLEnabler object.

Parameters:
csClientPath - - Path of the XML kColl where the SSL parameters are defined
Throws:
DSECSInvalidRequestException - - It has not been posible to initialize the SSLEnabler object
DSECSSSLException

getSSLSocket

java.net.Socket getSSLSocket(java.lang.String host,
                             int port)
                             throws java.net.UnknownHostException,
                                    java.io.IOException
Returns a secure socket.

Parameters:
host - - Hostname or ip address to connect the returned socket
port - - Port where the returned socket will be connected
Throws:
java.net.UnknownHostException
java.io.IOException

getEnabledCipherSuites

java.lang.String[] getEnabledCipherSuites()
Returns the enabledCipherSuites.

Returns:
String[]

setEnabledCipherSuites

void setEnabledCipherSuites(java.lang.String[] enabledCipherSuites)
Sets the enabledCipherSuites.

Parameters:
enabledCipherSuites - - The enabledCipherSuites to set

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009