public class FileBasedKeyManagerProvider extends KeyManagerProvider<FileBasedKeyManagerProviderCfg> implements ConfigurationChangeListener<FileBasedKeyManagerProviderCfg>
| Constructor and Description |
|---|
FileBasedKeyManagerProvider()
Creates a new instance of this file-based key manager provider.
|
| Modifier and Type | Method and Description |
|---|---|
ConfigChangeResult |
applyConfigurationChange(FileBasedKeyManagerProviderCfg configuration)
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(FileBasedKeyManagerProviderCfg configuration)
Initializes this key manager provider based on the information in
the provided key manager provider configuration.
|
boolean |
isConfigurationAcceptable(FileBasedKeyManagerProviderCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for
this key manager provider.
|
boolean |
isConfigurationChangeAcceptable(FileBasedKeyManagerProviderCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
public FileBasedKeyManagerProvider()
initializeKeyManagerProvider method must be called on the
resulting object before it may be used.public void initializeKeyManagerProvider(FileBasedKeyManagerProviderCfg configuration) throws ConfigException, InitializationException
KeyManagerProviderinitializeKeyManagerProvider in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>configuration - The key manager provider configuration that contains the
information to use to initialize this key manager
provider.ConfigException - If an unrecoverable problem arises in the process of
performing the initialization as a result of the server
configuration.InitializationException - If a problem occurs during initialization that is not
related to the server configuration.public void finalizeKeyManagerProvider()
finalizeKeyManagerProvider in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>public boolean containsKeyWithAlias(String alias)
KeyManagerProvidercontainsKeyWithAlias in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>alias - The alias to check.public KeyManager[] getKeyManagers() throws DirectoryException
KeyManagerProviderKeyManager objects that may be used
for interactions requiring access to a key manager.getKeyManagers in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>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()
KeyManagerProvidercontainsAtLeastOneKey in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>public boolean isConfigurationAcceptable(FileBasedKeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
KeyManagerProviderisConfigurationAcceptable in class KeyManagerProvider<FileBasedKeyManagerProviderCfg>configuration - 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(FileBasedKeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListenerisConfigurationChangeAcceptable in interface ConfigurationChangeListener<FileBasedKeyManagerProviderCfg>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.true if the proposed change is
acceptable, or false if it is not.public ConfigChangeResult applyConfigurationChange(FileBasedKeyManagerProviderCfg configuration)
ConfigurationChangeListenerapplyConfigurationChange in interface ConfigurationChangeListener<FileBasedKeyManagerProviderCfg>configuration - The new configuration containing the changes.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.