Package org.opends.server.extensions

Class Pkcs11TrustManagerProvider

java.lang.Object

org.opends.server.api.TrustManagerProvider<Pkcs11TrustManagerProviderCfg>

org.opends.server.extensions.Pkcs11TrustManagerProvider

All Implemented Interfaces:

ConfigurationChangeListener<Pkcs11TrustManagerProviderCfg>

public final class Pkcs11TrustManagerProvider
extends TrustManagerProvider<Pkcs11TrustManagerProviderCfg>
implements ConfigurationChangeListener<Pkcs11TrustManagerProviderCfg>

Define a trust manager provider that will access certificates stored on a PKCS#11 device. It will use the Java PKCS#11 interface, which may need to be configured on the underlying system.

Constructor Summary

Constructors

Constructor	Description
Pkcs11TrustManagerProvider()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(Pkcs11TrustManagerProviderCfg configuration)	Applies the configuration changes to this change listener.
void	finalizeTrustManagerProvider()	Performs any finalization that may be necessary for this trust manager provider.
TrustManager[]	getTrustManagers()	Retrieves a set of TrustManager objects that may be used for interactions requiring access to a trust manager.
void	initializeTrustManagerProvider(Pkcs11TrustManagerProviderCfg configuration)	Initializes this trust manager provider based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(Pkcs11TrustManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class org.opends.server.api.TrustManagerProvider

getServerContext, isConfigurationAcceptable, setServerContext

Methods inherited from class java.lang.Object

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

Constructor Details

Pkcs11TrustManagerProvider

public Pkcs11TrustManagerProvider()

Method Details

initializeTrustManagerProvider

public void initializeTrustManagerProvider(Pkcs11TrustManagerProviderCfg configuration)
                                    throws InitializationException

Description copied from class: TrustManagerProvider

Initializes this trust manager provider based on the information in the provided configuration entry.

Specified by:

initializeTrustManagerProvider in class TrustManagerProvider<Pkcs11TrustManagerProviderCfg>

Parameters:

configuration - The configuration to use for this trust manager provider.

Throws:

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

finalizeTrustManagerProvider

public void finalizeTrustManagerProvider()

Description copied from class: TrustManagerProvider

Performs any finalization that may be necessary for this trust manager provider.

Specified by:

finalizeTrustManagerProvider in class TrustManagerProvider<Pkcs11TrustManagerProviderCfg>

getTrustManagers

public TrustManager[] getTrustManagers()
                                throws LdapException

Description copied from class: TrustManagerProvider

Retrieves a set of TrustManager objects that may be used for interactions requiring access to a trust manager.

Specified by:

getTrustManagers in class TrustManagerProvider<Pkcs11TrustManagerProviderCfg>

Returns:

A set of TrustManager objects that may be used for interactions requiring access to a trust manager.

Throws:

LdapException - If a problem occurs while attempting to obtain the set of trust managers.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(Pkcs11TrustManagerProviderCfg configuration,
 List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<Pkcs11TrustManagerProviderCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(Pkcs11TrustManagerProviderCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<Pkcs11TrustManagerProviderCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.