public class LDAPKeyManagerProvider extends KeyManagerProvider<LdapKeyManagerProviderCfg> implements ConfigurationChangeListener<LdapKeyManagerProviderCfg>
Constructor and Description |
---|
LDAPKeyManagerProvider()
Creates a new LDAP key manager provider.
|
Modifier and Type | Method and 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<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this key manager provider.
|
boolean |
isConfigurationChangeAcceptable(LdapKeyManagerProviderCfg cfg,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
public LDAPKeyManagerProvider()
public void initializeKeyManagerProvider(LdapKeyManagerProviderCfg cfg) throws InitializationException
KeyManagerProvider
initializeKeyManagerProvider
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
cfg
- The key manager provider configuration that contains the information to use to initialize this key
manager provider.InitializationException
- If a problem occurs during initialization that is not related to the server configuration.public void finalizeKeyManagerProvider()
KeyManagerProvider
finalizeKeyManagerProvider
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
public boolean containsKeyWithAlias(String alias)
KeyManagerProvider
containsKeyWithAlias
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
alias
- The alias to check.public KeyManager[] getKeyManagers() throws DirectoryException
KeyManagerProvider
KeyManager
objects that may be used for interactions requiring access to a key
manager.getKeyManagers
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
KeyManager
objects that may be used for interactions requiring access to a key manager.DirectoryException
- If a problem occurs while attempting to obtain the set of key managers.public boolean containsAtLeastOneKey()
KeyManagerProvider
containsAtLeastOneKey
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
public boolean isConfigurationAcceptable(LdapKeyManagerProviderCfg cfg, List<LocalizableMessage> unacceptableReasons)
KeyManagerProvider
isConfigurationAcceptable
in class KeyManagerProvider<LdapKeyManagerProviderCfg>
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.true
if the provided configuration is acceptable for this key manager provider, or false
if not.public boolean isConfigurationChangeAcceptable(LdapKeyManagerProviderCfg cfg, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<LdapKeyManagerProviderCfg>
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.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(LdapKeyManagerProviderCfg cfg)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<LdapKeyManagerProviderCfg>
cfg
- The new configuration containing the changes.Copyright 2010-2020 ForgeRock AS.