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

All Superinterfaces:

Serializable

public interface SSLConfiguration
extends Serializable

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

An SSL configuration contains the following properties:

• alias: the alias in the key store to represent the client
• protocol: the SSL protocol
• certReqSubjectDN: the required Subject DN in the peer certificate
• contextProvider: the JSSE context provider
• keyStore: the key store file name
• keyStoreType: the key store file format
• keyStorePassword: the password to protect the key store file
• trustStore: the trust store file name
• trustStoreType: the trust store file format
• trustStorePassword: the password to protect the trust store file

Users are not recommended to implement this interface in case more methods are added in future releases.

Since:

WAS XD 6.0.1, XC10

See Also:

ClientSecurityConfiguration.setSSLConfiguration(SSLConfiguration)

Method Summary

boolean	equals(SSLConfiguration config) Checks two SSLConfiguration objects for equality.
String	getAlias() Gets the SSL alias name for this SSL configuration.
String	getCertReqSubjectDN() Gets the required subject DN in the peer certificate for this SSL configuration.
String	getContextProvider() Gets the JSSE context provider for this SSL configuration.
String	getKeyStore() Gets the key store file path name for this SSL configuration.
String	getKeyStorePassword() Gets the password of the key store for this SSL configuration.
String	getKeyStoreType() Gets the type of the key store for this SSL configuration.
String	getProtocol() Gets the SSL protocol for this SSL configuration.
String	getTrustStore() Gets the trust store file path name for this SSL configuration.
String	getTrustStorePassword() Gets the password of the trust store for this SSL configuration.
String	getTrustStoreType() Gets the type of the trust store for this SSL configuration.
void	setAlias(String alias) Sets the SSL alias name for this SSL configuration.
void	setCertReqSubjectDN(String subjectDN) Sets the required subject DN in the peer certificate for this SSL configuration.
void	setContextProvider(String contextProvider) Sets the JSSE context provider for this SSL configuration.
void	setKeyStore(String keyStore) Sets the key store file path name for this SSL configuration.
void	setKeyStorePassword(String keyStorePassword) Sets the password of the key store for this SSL configuration.
void	setKeyStoreType(String keyStoreType) Sets the type of key store for this SSL configuration.
void	setProtocol(String protocol) Sets the SSL protocol for this SSL configuration.
void	setTrustStore(String trustStore) Sets the trust store file path name for this SSL configuration.
void	setTrustStorePassword(String trustStorePassword) Sets the password of the trust store for this SSL configuration.
void	setTrustStoreType(String trustStoreType) Sets the type of the trust store for this SSL configuration.

Method Detail

getAlias

String getAlias()

Gets the SSL alias name for this SSL configuration.

Returns:

the argument that was passed to the setAlias(String) method of this interface or null if setAlias was not previously called for this object.

See Also:

setAlias(String)

setAlias

void setAlias(String alias)

Sets the SSL alias name for this SSL configuration.

Parameters:

alias - the SSL alias name

getProtocol

String getProtocol()

Gets the SSL protocol for this SSL configuration.

Returns:

the argument that was passed to the setProtocol(String) method of this interface or null if setProtocol was not previously called for this object.

See Also:

setProtocol(String)

setProtocol

void setProtocol(String protocol)

Sets the SSL protocol for this SSL configuration.

An SSL protocol can be SSL, TLS, SSLv2, SSLv3, etc., depending on which JDK is being used.

Parameters:

protocol - the SSL protocol

getContextProvider

String getContextProvider()

Gets the JSSE context provider for this SSL configuration.

Returns:

the argument that was passed to the setContextProvider(String) method of this interface or null if setContextProvider was not previously called for this object.

See Also:

setContextProvider(String)

setContextProvider

void setContextProvider(String contextProvider)

Sets the JSSE context provider for this SSL configuration.

A JSSE context provider can be SunJSSE, IBMJSSE2, IBMJSSE, etc., depending on which JDK is being used.

Parameters:

contextProvider - the SSL context provider

getKeyStore

String getKeyStore()

Gets the key store file path name for this SSL configuration.

Returns:

the absolute path of the argument that was passed to the setKeyStore(String) method of this interface or null if setKeyStore was not previously called for this object.

See Also:

setKeyStore(String)

setKeyStore

void setKeyStore(String keyStore)

Sets the key store file path name for this SSL configuration.

A keystore maintains the private key of an entity, as well as its corresponding public key certificates.

Parameters:

keyStore - the file path name of a keystore file

Throws:

IllegalArgumentException - if keyStore is null or a zero length String

See Also:

setKeyStorePassword(String), setKeyStoreType(String)

getKeyStorePassword

String getKeyStorePassword()

Gets the password of the key store for this SSL configuration.

Returns:

the argument that was passed to the setKeyStorePassword(String) method of this interface or null if setKeyStorePassword was not previously called for this object.

See Also:

setKeyStorePassword(String)

setKeyStorePassword

void setKeyStorePassword(String keyStorePassword)

Sets the password of the key store for this SSL configuration.

Parameters:

keyStorePassword - the password to access the keystore

See Also:

setKeyStore(String), setKeyStoreType(String)

getKeyStoreType

String getKeyStoreType()

Gets the type of the key store for this SSL configuration.

Returns:

the argument that was passed to the setKeyStoreType(String) method of this interface or null if setKeyStoreType was not previously called for this object.

See Also:

setKeyStoreType(String)

setKeyStoreType

void setKeyStoreType(String keyStoreType)

Sets the type of key store for this SSL configuration.

A key store type can be JKS, JCEK, etc.

Parameters:

keyStoreType - the type of the keystore

See Also:

setKeyStore(String), setKeyStorePassword(String)

getTrustStore

String getTrustStore()

Gets the trust store file path name for this SSL configuration.

Returns:

the absolute path of the argument that was passed to the setTrustStore(String) method of this interface or null if setTrustStore was not previously called for this object.

See Also:

setTrustStore(String)

setTrustStore

void setTrustStore(String trustStore)

Sets the trust store file path name for this SSL configuration.

A truststore contains certificates for the signers that are trusted in the environment where the truststore is used.

Parameters:

trustStore - the file path name to a trust store

Throws:

IllegalArgumentException - if trustStore is null or a zero length String

See Also:

setTrustStorePassword(String), setTrustStoreType(String)

getTrustStorePassword

String getTrustStorePassword()

Gets the password of the trust store for this SSL configuration.

Returns:

the argument that was passed to the setTrustStorePassword(String) method of this interface or null if setTrustStorePassword was not previously called for this object.

See Also:

setTrustStorePassword(String)

setTrustStorePassword

void setTrustStorePassword(String trustStorePassword)

Sets the password of the trust store for this SSL configuration.

Parameters:

trustStorePassword - the password to access the trust store

See Also:

setTrustStore(String), setTrustStoreType(String)

getTrustStoreType

String getTrustStoreType()

Gets the type of the trust store for this SSL configuration.

Returns:

the argument that was passed to the setTrustStoreType(String) method of this interface or null if setTrustStoreType was not previously called for this object.

See Also:

setTrustStoreType(String)

setTrustStoreType

void setTrustStoreType(String trustStoreType)

Sets the type of the trust store for this SSL configuration.

A trust store type can be JKS, JCEK, etc.

Parameters:

trustStoreType - the type of the trust store

See Also:

setTrustStore(String), setTrustStorePassword(String)

getCertReqSubjectDN

String getCertReqSubjectDN()

Gets the required subject DN in the peer certificate for this SSL configuration.

Returns:

the argument that was passed to the setCertReqSubjectDN(String) method of this interface or null if setCertReqSubjectDN was not previously called for this object.

setCertReqSubjectDN

void setCertReqSubjectDN(String subjectDN)

Sets the required subject DN in the peer certificate for this SSL configuration.

A connection will be opened only if the peer certficate's subject DN matches this value. Otherwise, the connection will be closed.

Parameters:

subjectDN - the required subject DN in the peer certificate

equals

boolean equals(SSLConfiguration config)

Checks two SSLConfiguration objects for equality.

Parameters:

config - the SSLConfiguration object we are testing for equality with this object.

Returns:

true if both SSLConfiguration objects are equivalent.