T
- The type of key manager provider configuration handled by
this key manager provider implementation.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true) public abstract class KeyManagerProvider<T extends org.forgerock.opendj.server.config.server.KeyManagerProviderCfg> extends Object
javax.net.ssl.KeyManager
objects for use when performing
SSL communication.Constructor and Description |
---|
KeyManagerProvider() |
Modifier and Type | Method and Description |
---|---|
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.
|
abstract void |
finalizeKeyManagerProvider()
Performs any finalization that may be necessary for this key
manager provider.
|
abstract KeyManager[] |
getKeyManagers()
Retrieves a set of
KeyManager objects that may be used
for interactions requiring access to a key manager. |
abstract void |
initializeKeyManagerProvider(T configuration)
Initializes this key manager provider based on the information in
the provided key manager provider configuration.
|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for
this key manager provider.
|
public KeyManagerProvider()
public abstract void initializeKeyManagerProvider(T configuration) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
configuration
- 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 boolean containsKeyWithAlias(String alias)
alias
- The alias to check.public boolean containsAtLeastOneKey()
public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
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 abstract void finalizeKeyManagerProvider()
public abstract KeyManager[] getKeyManagers() throws DirectoryException
KeyManager
objects that may be used
for interactions requiring access to a key manager.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.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.