com.entrust.toolkit.smproxy

Class SMProxyTrustStoreSingleton

java.lang.Object

com.entrust.toolkit.smproxy.SMProxyTrustStoreSingleton

All Implemented Interfaces:

LogoutListener

public class SMProxyTrustStoreSingleton
extends java.lang.Object
implements LogoutListener

The purpose of this class is the overcome a limitation of the LDAP Context's custom socket implementation when securing the proxy connection with SSL. This limitation is a result of the Context allowing the socket to be customized by providing a custom SMProxySSLSocketFactory as an environment parameter. The custom Socket is then instantiated by the getDefault() method which is static. The result of this limitation is that all data, including trusted certificates, X509TrustManager, or X509KeyManagers must be available from a static context.

To overcome this limitation, this object is created as a Singleton, a single instance of a static object so that the required proxy SSL configuration parameters can be created from the static context of the SMProxySSLSocketFactory.getDefault() method.

Note: The SMProxyTrustStoreSingleton can be returned from any context by calling:

 SMProxyTrustStoreSingleton.getSMProxyTrustStoreSingleton();
 

Since:

8.1

Method Summary

Modifier and Type	Method and Description
boolean	addCertificate(java.security.cert.X509Certificate cert) Adds a certificate to this object.
void	addCertificates(java.security.cert.X509Certificate[] certs) Adds a certificate to the SMProxy trustStore.
void	clearTrustStore() Clears the list of certificates, trustStore used by SMProxy.
JSSEX509KeyManager	getKeyManager() Returns a previously set JSSEX509KeyManager
java.security.cert.X509Certificate[]	getSMProxyTrustStoreCerts() Returns the list of trusted certificates that are stored by the Singleton object.
static SMProxyTrustStoreSingleton	getSMProxyTrustStoreSingleton() Returns the SMProxyTrustStoreSingleton.
JSSEX509TrustManager	getTrustManager() Returns the JSSEX509TrustManager.
void	logout() The logout callback function; called from the user when logging out.
boolean	removeCertificate(java.security.cert.X509Certificate cert) Removes a certificate from the SMProxy trustStore if it is contained in the trustStore
void	setKeyManager(JSSEX509KeyManager keyManager) Sets the JSSEX509KeyManager to use for SMProxy SSL connections
void	setTrustManager(JSSEX509TrustManager trustManager) Sets the JSSEX509TrustManager to use for SMProxy SSL connections

Methods inherited from class java.lang.Object

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

Method Detail

addCertificate

public boolean addCertificate(java.security.cert.X509Certificate cert)

Adds a certificate to this object. If the certificate is already contained in this object it will not be added again.

Parameters:

cert - the certificate to add

Returns:

true if the certificate was added, false if it was not added

removeCertificate

public boolean removeCertificate(java.security.cert.X509Certificate cert)

Removes a certificate from the SMProxy trustStore if it is contained in the trustStore

Parameters:

cert - the certificate to add

Returns:

true if the certificate was removed, false if it was not removed.

addCertificates

public void addCertificates(java.security.cert.X509Certificate[] certs)

Adds a certificate to the SMProxy trustStore. If the certificate is already contained in this truststore it will not be added again.

Parameters:

certs - the certificates to add

getSMProxyTrustStoreSingleton

public static SMProxyTrustStoreSingleton getSMProxyTrustStoreSingleton()

Returns the SMProxyTrustStoreSingleton. To ensure that there is only one SMProxyTrustStoreSingleton, the constructor is private. Use this method to get the Singleton.

Returns:

the unique SMProxyTrustStoreSingleton graph

getSMProxyTrustStoreCerts

public java.security.cert.X509Certificate[] getSMProxyTrustStoreCerts()

Returns the list of trusted certificates that are stored by the Singleton object.

Returns:

the list of X509Certificates trusted by this repository.

clearTrustStore

public void clearTrustStore()

Clears the list of certificates, trustStore used by SMProxy.

getTrustManager

public JSSEX509TrustManager getTrustManager()

Returns the JSSEX509TrustManager. If no JSSEX509TrustManager was set but certificates have been explicitly added, a new JSSEX509TrustManager will be created using these certificates.

Returns:

an JSSEX509TrustManager

setTrustManager

public void setTrustManager(JSSEX509TrustManager trustManager)

Sets the JSSEX509TrustManager to use for SMProxy SSL connections

Parameters:

trustManager - the JSSEX509TrustManager to set

getKeyManager

public JSSEX509KeyManager getKeyManager()

Returns a previously set JSSEX509KeyManager

Returns:

the JSSEX509KeyManager

setKeyManager

public void setKeyManager(JSSEX509KeyManager keyManager)

Sets the JSSEX509KeyManager to use for SMProxy SSL connections

Parameters:

keyManager - the JSSEX509KeyManager to set

logout

public void logout()

Description copied from interface: LogoutListener

The logout callback function; called from the user when logging out.

Specified by:

logout in interface LogoutListener