Package org.opends.server.extensions

Class LDAPKeyManagerProvider

java.lang.Object

org.opends.server.api.KeyManagerProvider<LDAPKeyManagerProviderCfg>

org.opends.server.extensions.LDAPKeyManagerProvider

All Implemented Interfaces:

ConfigurationChangeListener<LDAPKeyManagerProviderCfg>

public class LDAPKeyManagerProvider
extends KeyManagerProvider<LDAPKeyManagerProviderCfg>
implements ConfigurationChangeListener<LDAPKeyManagerProviderCfg>

This class defines a key manager provider that will access keys stored in an LDAP backend.

Constructor Summary

Constructors

Constructor	Description
LDAPKeyManagerProvider()	Creates a new LDAP key manager provider.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(LDAPKeyManagerProviderCfg cfg)	Applies the configuration changes to this change listener.
boolean	containsAtLeastOneKey()	Verifies that the keystore has at least one usable key.
boolean	containsKeyWithAlias(String alias)	Verifies that an alias is defined in the scope of this Key Manager.
void	finalizeKeyManagerProvider()	Performs any finalization that may be necessary for this key manager provider.
KeyManager[]	getKeyManagers()	Retrieves a set of KeyManager objects that may be used for interactions requiring access to a key manager.
void	initializeKeyManagerProvider(LDAPKeyManagerProviderCfg cfg)	Initializes this key manager provider based on the information in the provided key manager provider configuration.
boolean	isConfigurationAcceptable(LDAPKeyManagerProviderCfg cfg, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this key manager provider.
boolean	isConfigurationChangeAcceptable(LDAPKeyManagerProviderCfg cfg, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPKeyManagerProvider

public LDAPKeyManagerProvider()

Creates a new LDAP key manager provider.

Method Detail

initializeKeyManagerProvider

public void initializeKeyManagerProvider(LDAPKeyManagerProviderCfg cfg)
                                  throws InitializationException

Description copied from class: KeyManagerProvider

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

Specified by:

initializeKeyManagerProvider in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

Parameters:

cfg - The key manager provider configuration that contains the information to use to initialize this key manager provider.

Throws:

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

finalizeKeyManagerProvider

public void finalizeKeyManagerProvider()

Description copied from class: KeyManagerProvider

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

Specified by:

finalizeKeyManagerProvider in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

containsKeyWithAlias

public boolean containsKeyWithAlias(String alias)

Description copied from class: KeyManagerProvider

Verifies that an alias is defined in the scope of this Key Manager.

Overrides:

containsKeyWithAlias in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

Parameters:

alias - The alias to check.

Returns:

true if the alias exists, false otherwise

getKeyManagers

public KeyManager[] getKeyManagers()
                            throws DirectoryException

Description copied from class: KeyManagerProvider

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

Specified by:

getKeyManagers in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

Returns:

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

Throws:

DirectoryException - If a problem occurs while attempting to obtain the set of key managers.

containsAtLeastOneKey

public boolean containsAtLeastOneKey()

Description copied from class: KeyManagerProvider

Verifies that the keystore has at least one usable key.

Overrides:

containsAtLeastOneKey in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

Returns:

true if the keystore has at least one usable key, false otherwise

isConfigurationAcceptable

public boolean isConfigurationAcceptable(LDAPKeyManagerProviderCfg cfg,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from class: KeyManagerProvider

Indicates whether the provided configuration is acceptable for this key manager provider. It should be possible to call this method on an uninitialized key manager provider instance in order to determine whether the key manager provider would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Overrides:

isConfigurationAcceptable in class KeyManagerProvider<LDAPKeyManagerProviderCfg>

Parameters:

cfg - The key manager provider configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this key manager provider, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(LDAPKeyManagerProviderCfg cfg,
                                               List<org.forgerock.i18n.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<LDAPKeyManagerProviderCfg>

Parameters:

cfg - 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(LDAPKeyManagerProviderCfg cfg)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<LDAPKeyManagerProviderCfg>

Parameters:

cfg - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.