com.unboundid.directory.sdk.common.api

Class KeyManagerProvider

java.lang.Object

com.unboundid.directory.sdk.common.api.KeyManagerProvider

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<KeyManagerProviderConfig>, UnboundIDExtension

@Extensible
 @DirectoryServerExtension
 @DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
 @SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
 @MetricsEngineExtension
 @BrokerExtension
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class KeyManagerProvider
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<KeyManagerProviderConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which provide access to key managers. Key managers allow the server to access certificates in a form that can be presented to another system during SSL or StartTLS negotiation. If the server is configured to accept secure communication from clients, then a key manager provider will be used to access the certificate that the server presents to the client. If the server needs to establish a secure connection to another system (e.g., the Directory Proxy Server connecting to a backend Directory Server instance), then the key manager provider may also be used to obtain a client certificate that may be used for authentication.

Configuring Key Manager Providers

In order to configure a key manager provider created using this API, use a command like:

      dsconfig create-key-manager-provider \
           --provider-name "{provider-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

where "{provider-name}" is the name to use for the key manager provider instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.KeyManagerProvider, and "{name=value}" represents name-value pairs for any arguments to provide to the key manager provider. If multiple arguments should be provided to the key manager provider, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

Constructor and Description
KeyManagerProvider() Creates a new instance of this key manager provider.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(KeyManagerProviderConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages) Attempts to apply the configuration from the provided argument parser to this extension.
void	defineConfigArguments(ArgumentParser parser) Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeKeyManagerProvider() Performs any cleanup which may be necessary when this key manager provider is to be taken out of service.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	getExamplesArgumentSets() Retrieves a map containing examples of configurations that may be used for this extension.
abstract java.lang.String[]	getExtensionDescription() Retrieves a human-readable description for this extension.
abstract java.lang.String	getExtensionName() Retrieves a human-readable name for this extension.
abstract javax.net.ssl.KeyManager[]	getKeyManagers() Retrieves a set of key managers that may be used for operations within the server which may require access to certificates.
void	initializeKeyManagerProvider(ServerContext serverContext, KeyManagerProviderConfig config, ArgumentParser parser) Initializes this key manager provider.
boolean	isConfigurationAcceptable(KeyManagerProviderConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons) Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyManagerProvider

public KeyManagerProvider()

Creates a new instance of this key manager provider. All key manager provider implementations must include a default constructor, but any initialization should generally be done in the initializeKeyManagerProvider method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

getExtensionDescription

public abstract java.lang.String[] getExtensionDescription()

Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.

Specified by:

getExtensionDescription in interface UnboundIDExtension

Returns:

A human-readable description for this extension, or null or an empty array if no description should be available.

defineConfigArguments

public void defineConfigArguments(ArgumentParser parser)
                           throws ArgumentException

Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).

Specified by:

defineConfigArguments in interface Configurable

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeKeyManagerProvider

public void initializeKeyManagerProvider(ServerContext serverContext,
                                         KeyManagerProviderConfig config,
                                         ArgumentParser parser)
                                  throws LDAPException

Initializes this key manager provider.

Parameters:

serverContext - A handle to the server context for the server in which this extension is running.

config - The general configuration for this key manager provider.

parser - The argument parser which has been initialized from the configuration for this key manager provider.

Throws:

LDAPException - If a problem occurs while initializing this key manager provider.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(KeyManagerProviderConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.

Specified by:

isConfigurationAcceptable in interface Reconfigurable<KeyManagerProviderConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the proposed configuration for this extension.

unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.

Returns:

true if the configuration in the provided argument parser appears to be acceptable, or false if not.

applyConfiguration

public ResultCode applyConfiguration(KeyManagerProviderConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)

Attempts to apply the configuration from the provided argument parser to this extension.

Specified by:

applyConfiguration in interface Reconfigurable<KeyManagerProviderConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the new configuration for this extension.

adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.

messages - A list to which messages may be added to provide additional information about the processing performed by this method.

Returns:

A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

finalizeKeyManagerProvider

public void finalizeKeyManagerProvider()

Performs any cleanup which may be necessary when this key manager provider is to be taken out of service.

getKeyManagers

public abstract javax.net.ssl.KeyManager[] getKeyManagers()
                                                   throws LDAPException

Retrieves a set of key managers that may be used for operations within the server which may require access to certificates.

Returns:

The set of key managers that may be used for operations within the server which may require access to certificates.

Throws:

LDAPException - If a problem occurs while attempting to retrieve the key managers.

getExamplesArgumentSets

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()

Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.

Specified by:

getExamplesArgumentSets in interface ExampleUsageProvider

Returns:

A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.