public final class PKCS11KeyManagerProvider extends KeyManagerProvider<Pkcs11KeyManagerProviderCfg> implements ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg>
KeyManagerProvider.CertificateMonitor
Constructor and Description |
---|
PKCS11KeyManagerProvider() |
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(Pkcs11KeyManagerProviderCfg configuration)
Applies the configuration changes to this change listener.
|
protected void |
finalizeKeyManagerProviderImpl()
Performs any other finalization actions that may be necessary by this key manager provider implementation.
|
KeyManager[] |
getKeyManagers()
Retrieves a set of
KeyManager objects that may be used for interactions requiring access to a key
manager. |
protected KeyStore |
getKeyStore()
Returns the keystore used by this key manager provider.
|
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, containsKeyWithAlias, finalizeKeyManagerProvider, getConfig, getName, registerCertificateMonitorEntries, setConfig, toString
public void initializeKeyManagerProvider(Pkcs11KeyManagerProviderCfg configuration) throws InitializationException
KeyManagerProvider
initializeKeyManagerProvider
in class KeyManagerProvider<Pkcs11KeyManagerProviderCfg>
configuration
- 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.protected void finalizeKeyManagerProviderImpl()
KeyManagerProvider
finalizeKeyManagerProviderImpl
in class KeyManagerProvider<Pkcs11KeyManagerProviderCfg>
public KeyManager[] getKeyManagers() throws LdapException
KeyManagerProvider
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.LdapException
- If a problem occurs while attempting to obtain the set of key managers.public boolean isConfigurationAcceptable(Pkcs11KeyManagerProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
KeyManagerProvider
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)
ConfigurationChangeListener
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)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg>
configuration
- The new configuration containing the changes.protected KeyStore getKeyStore() throws LdapException
KeyManagerProvider
getKeyStore
in class KeyManagerProvider<Pkcs11KeyManagerProviderCfg>
KeyStore
used by this key manager provider.LdapException
- If a problem occurs while attempting to retrieve the keystore.Copyright 2010-2022 ForgeRock AS.