Package com.unboundid.directory.sdk.common.api

Class PassphraseProvider

java.lang.Object

com.unboundid.directory.sdk.common.api.PassphraseProvider

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<PassphraseProviderConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions that provide passphrases for server components like external servers and access to key or trust stores.

Configuring Passphrase Providers

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

      dsconfig create-passphrase-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 passphrase provider instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.PassphraseProvider, and "{name=value}" represents name-value pairs for any arguments to provide to the passphrase provider. If multiple arguments should be provided to the passphrase provider, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

Constructor	Description
PassphraseProvider()	Creates a new instance of this passphrase provider.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(PassphraseProviderConfig 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	finalizePassphraseProvider()	Performs any cleanup which may be necessary when this passphrase 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 char[]	getPassphrase(boolean allowCached)	Retrieves the passphrase.
void	initializePassphraseProvider(ServerContext serverContext, PassphraseProviderConfig config, ArgumentParser parser)	Initializes this passphrase provider.
boolean	isConfigurationAcceptable(PassphraseProviderConfig 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

PassphraseProvider

public PassphraseProvider()

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

Method Detail

getExtensionName

@NotNull
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

@Nullable
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(@NotNull
                                  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.

initializePassphraseProvider

public void initializePassphraseProvider(@NotNull
                                         ServerContext serverContext,
                                         @NotNull
                                         PassphraseProviderConfig config,
                                         @NotNull
                                         ArgumentParser parser)
                                  throws LDAPException

Initializes this passphrase provider.

Parameters:

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

config - The general configuration for this passphrase provider.

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

Throws:

LDAPException - If a problem occurs while initializing this passphrase provider.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(@NotNull
                                         PassphraseProviderConfig config,
                                         @NotNull
                                         ArgumentParser parser,
                                         @NotNull
                                         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<PassphraseProviderConfig>

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

@NotNull
public ResultCode applyConfiguration(@NotNull
                                     PassphraseProviderConfig config,
                                     @NotNull
                                     ArgumentParser parser,
                                     @NotNull
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     @NotNull
                                     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<PassphraseProviderConfig>

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.

finalizePassphraseProvider

public void finalizePassphraseProvider()

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

getPassphrase

@NotNull
public abstract char[] getPassphrase(boolean allowCached)
                              throws LDAPException

Retrieves the passphrase.

Parameters:

allowCached - Indicates whether to allow the server to use a cached version of the passphrase.

Returns:

The passphrase that should be used. It must not be null or empty.

Throws:

LDAPException - If the passphrase cannot be retrieved.

getExamplesArgumentSets

@Nullable
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.