public class PKCS11KeyManagerProvider extends KeyManagerProvider<PKCS11KeyManagerProviderCfg> implements ConfigurationChangeListener<PKCS11KeyManagerProviderCfg>
| Modifier and Type | Field and Description |
|---|---|
static String |
PKCS11_KEYSTORE_TYPE
The keystore type to use when accessing the PKCS#11 keystore.
|
| Constructor and Description |
|---|
PKCS11KeyManagerProvider()
Creates a new instance of this PKCS#11 key manager provider.
|
| Modifier and Type | Method and Description |
|---|---|
ConfigChangeResult |
applyConfigurationChange(PKCS11KeyManagerProviderCfg configuration)
Applies the configuration changes to this change listener.
|
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(PKCS11KeyManagerProviderCfg configuration)
Initializes this key manager provider based on the information in
the provided key manager provider configuration.
|
boolean |
isConfigurationAcceptable(PKCS11KeyManagerProviderCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for
this key manager provider.
|
boolean |
isConfigurationChangeAcceptable(PKCS11KeyManagerProviderCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
containsAtLeastOneKey, containsKeyWithAliaspublic static final String PKCS11_KEYSTORE_TYPE
public PKCS11KeyManagerProvider()
initializeKeyManagerProvider method must be called on the
resulting object before it may be used.public void initializeKeyManagerProvider(PKCS11KeyManagerProviderCfg configuration) throws ConfigException, InitializationException
initializeKeyManagerProvider in class KeyManagerProvider<PKCS11KeyManagerProviderCfg>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<PKCS11KeyManagerProviderCfg>public KeyManager[] getKeyManagers() throws DirectoryException
KeyManager objects that may be used for
interactions requiring access to a key manager.getKeyManagers in class KeyManagerProvider<PKCS11KeyManagerProviderCfg>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 isConfigurationAcceptable(PKCS11KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationAcceptable in class KeyManagerProvider<PKCS11KeyManagerProviderCfg>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(PKCS11KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<PKCS11KeyManagerProviderCfg>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(PKCS11KeyManagerProviderCfg configuration)
applyConfigurationChange in interface ConfigurationChangeListener<PKCS11KeyManagerProviderCfg>configuration - The new configuration containing the changes.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.