IBM WebSphere Extended Deployment (XD)TM
Release 6.0

com.ibm.websphere.objectgrid.security.config
SSLConfiguration

All Implemented Interfaces
Serializable


This interface represents an SSL Configuration. Users can call ConfigurationFactory.getSSLConfiguration() to get an instance of SSLConfiguration.

An SSL configuration contains the following properties:

Users are not recommended to implement this interface.




Method Summary
public  StringgetAlias()
          
public  voidsetAlias(java.lang.String)
          
public  StringgetProtocol()
           This method gets the SSL protocol to be used. An SSL protocol can be .
public  voidsetProtocol(java.lang.String)
           This method sets the SSL protocol to be used. An SSL protocol can be .
public  StringgetContextProvider()
           This methods gets the JSSE context provider. A JSSE context provider can .
public  voidsetContextProvider(java.lang.String)
           This methods sets the JSSE context provider. A JSSE context provider can .
public  StringgetKeyStore()
           This method gets the key store file path name. A keystore maintains the .
public  voidsetKeyStore(java.lang.String)
           This method sets the key store file path name. A keystore maintains the .
public  StringgetKeyStorePassword()
           This method gets the key store password.
public  voidsetKeyStorePassword(java.lang.String)
           This method sets the key store password.
public  StringgetKeyStoreType()
           This method gets the key store type. A key store type can be JKS, JCEK,.
public  voidsetKeyStoreType(java.lang.String)
           This method gets the key store type. A key store type can be JKS, JCEK,.
public  StringgetTrustStore()
           This method gets the trust store file path name. A truststore contains .
public  voidsetTrustStore(java.lang.String)
           This method sets the trust store file path name. A truststore contains .
public  StringgetTrustStorePassword()
           This method gets the trust store password.
public  voidsetTrustStorePassword(java.lang.String)
           This method sets the trust store password.
public  StringgetTrustStoreType()
           This method gets the trust store type. A trust store type can be JKS, JCEK,.
public  voidsetTrustStoreType(java.lang.String)
           This method sets the trust store type. A trust store type can be JKS, JCEK,.
public  StringgetCertReqSubjectDN()
           This method gets the required subject DN in the peer certificate. Only if the .
public  voidsetCertReqSubjectDN(java.lang.String)
           This method sets the required subject DN in the peer certificate. Only if the .
public  booleanequals(com.ibm.websphere.objectgrid.security.config.SSLConfiguration)
           If the two SSLConfiguration points to the same value for every proprety, then we return true; otherwise false is returned.

Method Detail

getAlias

public String getAlias()


Returns:
     the SSL alias name


setAlias

public void setAlias(String alias)
Set the SSL alias name
Parameters:
    alias - the SSL alias name


getProtocol

public String getProtocol()
This method gets the SSL protocol to be used. An SSL protocol can be SSL, TLS, TLS2, etc. depending on which JDK is used.


Returns:
     the SSL protocol


setProtocol

public void setProtocol(String protocol)
This method sets the SSL protocol to be used. An SSL protocol can be SSL, TLS, SSLv2, SSLv3, etc., depending on which JDK is used.
Parameters:


getContextProvider

public String getContextProvider()
This methods gets the JSSE context provider. A JSSE context provider can be SunJSSE, IBMJSSE, IBMJSSE2, etc., depending on which JDK is used.


Returns:
     SSL context provider


setContextProvider

public void setContextProvider(String contextProvider)
This methods sets the JSSE context provider. A JSSE context provider can be SunJSSE, IBMJSSE, IBMJSSE2, etc., depending on which JDK is used.
Parameters:


getKeyStore

public String getKeyStore()
This method gets the key store file path name. A keystore maintains the private key of an entity, as well as its corresponding public key certificates.


Returns:
     the SSL key store file


setKeyStore

public void setKeyStore(String keyStore)
This method sets the key store file path name. A keystore maintains the private key of an entity, as well as its corresponding public key certificates.
Parameters:


getKeyStorePassword

public String getKeyStorePassword()
This method gets the key store password.


Returns:
     the SSL key store password


setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)
This method sets the key store password.
Parameters:


getKeyStoreType

public String getKeyStoreType()
This method gets the key store type. A key store type can be JKS, JCEK, etc.


Returns:
     the key store type


setKeyStoreType

public void setKeyStoreType(String keyStoreType)
This method gets the key store type. A key store type can be JKS, JCEK, etc.
Parameters:


getTrustStore

public String getTrustStore()
This method gets the trust store file path name. A truststore contains certificates for the signers that are trusted in the environment where the truststore is used.


Returns:
     the SSL trust store


setTrustStore

public void setTrustStore(String trustStore)
This method sets the trust store file path name. A truststore contains certificates for the signers that are trusted in the environment where the truststore is used.
Parameters:


getTrustStorePassword

public String getTrustStorePassword()
This method gets the trust store password.


Returns:
     the SSL trust store password


setTrustStorePassword

public void setTrustStorePassword(String trustStorePassword)
This method sets the trust store password.
Parameters:


getTrustStoreType

public String getTrustStoreType()
This method gets the trust store type. A trust store type can be JKS, JCEK, etc.


Returns:
     the SSL trust store type


setTrustStoreType

public void setTrustStoreType(String trustStoreType)
This method sets the trust store type. A trust store type can be JKS, JCEK, etc.
Parameters:


getCertReqSubjectDN

public String getCertReqSubjectDN()
This method gets the required subject DN in the peer certificate. Only if the peer certficate's subject DN matches this value, the connection will be opened. Otherwise, the connection will be closed.


Returns:
     the required subject DN in the peer certificate


setCertReqSubjectDN

public void setCertReqSubjectDN(String subjectDN)
This method sets the required subject DN in the peer certificate. Only if the peer certficate's subject DN matches this value, the connection will be opened. Otherwise, the connection will be closed.
Parameters:
    subjectDN - the required subject DN in the peer certificate


equals

public boolean equals(SSLConfiguration config)
If the two SSLConfiguration points to the same value for every proprety, then we return true; otherwise false is returned.
Parameters:


IBM WebSphere Extended Deployment (XD)TM
Release 6.0