COM.activesw.api.client

Class BrokerSSLConfigV2

java.lang.Object

COM.activesw.api.client.BrokerSSLConfigV2

public class BrokerSSLConfigV2
extends java.lang.Object

This class is a data structure used to describe a broker's SSL configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrokerSSLConfigV2.CRLType
static class	BrokerSSLConfigV2.KeystoreType
static class	BrokerSSLConfigV2.SSLProtocol
static class	BrokerSSLConfigV2.TruststoreType

Constructor Summary

Constructors

Constructor and Description
BrokerSSLConfigV2() Create an empty SSL config object
BrokerSSLConfigV2(BrokerSSLConfigV2 source)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object sslConfig)
java.lang.String	getCipherSuites() Return the current cipher suites specification for this configuration
java.lang.String	getCrl() Get the SSL Crl used by this configuration
BrokerSSLConfigV2.CRLType	getCrlType() Return the type of the crl file
java.lang.String	getKeystore() Get the SSL Keystore used by this configuration
java.lang.String	getKeystorePassword() Returns the password for the keystore
BrokerSSLConfigV2.KeystoreType	getKeystoreType() Return the type of the keystore file
BrokerSSLConfigV2.SSLProtocol	getSslProtocol() Get the current SSL Protocols allowed
java.lang.String	getTruststore() Get the SSL Truststore used by this configuration
BrokerSSLConfigV2.TruststoreType	getTruststoreType() Return the type of the truststore file
int	getVerifyDepth() Get the number of CA certificates in a verification chain to check.
int	hashCode()
void	setCipherSuites(java.lang.String newCipherSuites) Specify the cipher suites to allow with this configuration.
void	setCrl(java.lang.String crl) Set the SSL Crl used by this configuration.
void	setCrlType(java.lang.String crlType) Set the crl file type.
void	setKeystore(java.lang.String newKeystore) Set the SSL Keystore used by this configuration.
void	setKeystorePassword(java.lang.String newPassword) Set the password for the keystore
void	setKeystoreType(BrokerSSLConfigV2.KeystoreType newKeystoreType) Set the keystore file type.
void	setKeystoreType(java.lang.String newKeystoreType) Set the keystore file type.
void	setSslProtocol(java.lang.String newSslProtocol) Set the SSL protocols that this configuration allows.
void	setTruststore(java.lang.String newTruststore) Set the SSL Truststore used by this configuration.
void	setTruststoreType(BrokerSSLConfigV2.TruststoreType newTruststoreType) Set the truststore file type.
void	setTruststoreType(java.lang.String newTruststoreType) Set the truststore file type.
void	setVerifyDepth(int newVerifyDepth) Set the maximum number of CA certificates to verify in a certificate chain.
java.lang.String	toString(int indent_level) Convert to a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerSSLConfigV2

public BrokerSSLConfigV2()

Create an empty SSL config object

BrokerSSLConfigV2

public BrokerSSLConfigV2(BrokerSSLConfigV2 source)

Method Detail

getKeystore

public java.lang.String getKeystore()

Get the SSL Keystore used by this configuration

Returns:

the SSL Keystore

setKeystore

public void setKeystore(java.lang.String newKeystore)

Set the SSL Keystore used by this configuration. The newKeystore parameter must be the full path to the keystore file on the machine where the Broker Server is running.

Parameters:

newKeystore - path to keystore

getKeystorePassword

public java.lang.String getKeystorePassword()

Returns the password for the keystore

Returns:

the password for the keystore

setKeystorePassword

public void setKeystorePassword(java.lang.String newPassword)

Set the password for the keystore

Parameters:

newPassword - keystore password

getKeystoreType

public BrokerSSLConfigV2.KeystoreType getKeystoreType()

Return the type of the keystore file

Returns:

the keystore file type

setKeystoreType

public void setKeystoreType(BrokerSSLConfigV2.KeystoreType newKeystoreType)

Set the keystore file type.

Parameters:

newKeystoreType - the type of the keystore file

setKeystoreType

public void setKeystoreType(java.lang.String newKeystoreType)
                     throws BrokerSSLConfigException

Set the keystore file type. The type must be:

KEYSTORE_TYPE_PKCS12/code>

KEYSTORE_TYPE_PEM or

null

If the type is null, then the default keystore type (KEYSTORE_TYPE_PKCS12) is used.

Parameters:

newKeystoreType - the type of the keystore file

Throws:

BrokerSSLConfigException - if the keystore type is not valid

getTruststore

public java.lang.String getTruststore()

Get the SSL Truststore used by this configuration

Returns:

the SSL Truststore

setTruststore

public void setTruststore(java.lang.String newTruststore)

Set the SSL Truststore used by this configuration. The newTruststore parameter must be the full path to the truststore file on the machine where the Broker Server is running.

Parameters:

newTruststore - path to keystore

getTruststoreType

public BrokerSSLConfigV2.TruststoreType getTruststoreType()

Return the type of the truststore file

Returns:

the truststore file type

setTruststoreType

public void setTruststoreType(BrokerSSLConfigV2.TruststoreType newTruststoreType)

Set the truststore file type.

Parameters:

newTruststoreType - the type of the truststore file

setTruststoreType

public void setTruststoreType(java.lang.String newTruststoreType)
                       throws BrokerSSLConfigException

Set the truststore file type. The type must be:

TRUSTSTORE_TYPE_PEM/code>

TRUSTSTORE_TYPE_DIR or

null

If the type is null, then the default truststore type (TRUSTSTORE_TYPE_PEM) is used.