public class FileBasedKeyManagerProvider extends KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg> implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
Constructor and Description |
---|
FileBasedKeyManagerProvider()
Creates a new instance of this file-based key manager provider.
|
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg) |
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(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg)
Initializes this key manager provider based on the information in the provided key manager provider
configuration.
|
boolean |
isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this key manager provider.
|
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg,
List<LocalizableMessage> unacceptableReasons) |
public FileBasedKeyManagerProvider()
initializeKeyManagerProvider
method must be called on the resulting object before it may be used.public void initializeKeyManagerProvider(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
KeyManagerProvider
initializeKeyManagerProvider
in class KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
cfg
- The key manager provider configuration that contains the information to use to initialize this key
manager provider.org.forgerock.opendj.config.server.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()
KeyManagerProvider
finalizeKeyManagerProvider
in class KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
public boolean containsKeyWithAlias(String alias)
KeyManagerProvider
containsKeyWithAlias
in class KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
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<org.forgerock.opendj.server.config.server.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()
KeyManagerProvider
containsAtLeastOneKey
in class KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg, List<LocalizableMessage> unacceptableReasons)
KeyManagerProvider
isConfigurationAcceptable
in class KeyManagerProvider<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
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(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg cfg)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedKeyManagerProviderCfg>
Copyright © 2010–2017 ForgeRock AS. All rights reserved.