com.unboundid.directory.sdk.ds.scripting

Class ScriptedPasswordGenerator

java.lang.Object

com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

All Implemented Interfaces:

Configurable, Reconfigurable<PasswordGeneratorConfig>

@Extensible
 @DirectoryServerExtension
 @DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
 @SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class ScriptedPasswordGenerator
extends java.lang.Object
implements Reconfigurable<PasswordGeneratorConfig>

This class defines an API that must be implemented by scripted extensions which generate user passwords. This is primarily used when processing a password modify extended operation in order to generate a new password for the target user if the request did not explicitly provide the new password that should be used. The generated password will not be subject to the constraints of any defined password validators.

Configuring Groovy-Scripted Password Generators

In order to configure a scripted password generator based on this API and written in the Groovy scripting language, use a command like:

      dsconfig create-password-generator \
           --generator-name "{generator-name}" \
           --type groovy-scripted \
           --set enabled:true \
           --set "script-class:{class-name}" \
           --set "script-argument:{name=value}"
 

where "{generator-name}" is the name to use for the password generator instance, "{class-name}" is the fully-qualified name of the Groovy class written using this API, and "{name=value}" represents name-value pairs for any arguments to provide to the password generator. If multiple arguments should be provided to the password generator, then the "--set script-argument:{name=value}" option should be provided multiple times.

See Also:

PasswordGenerator

Constructor Summary

Constructors

Constructor and Description
ScriptedPasswordGenerator() Creates a new instance of this password generator.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(PasswordGeneratorConfig 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	finalizePasswordGenerator() Performs any cleanup which may be necessary when this password generator is to be taken out of service.
abstract ByteString	generatePassword(Entry userEntry) Performs any processing which may be necessary to generate a user password.
void	initializePasswordGenerator(DirectoryServerContext serverContext, PasswordGeneratorConfig config, ArgumentParser parser) Initializes this password generator.
boolean	isConfigurationAcceptable(PasswordGeneratorConfig 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

ScriptedPasswordGenerator

public ScriptedPasswordGenerator()

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

Method Detail

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.

initializePasswordGenerator

public void initializePasswordGenerator(DirectoryServerContext serverContext,
                                        PasswordGeneratorConfig config,
                                        ArgumentParser parser)
                                 throws LDAPException

Initializes this password generator.

Parameters:

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

config - The general configuration for this password generator.

parser - The argument parser which has been initialized from the configuration for this password generator.

Throws:

LDAPException - If a problem occurs while initializing this password generator.

finalizePasswordGenerator

public void finalizePasswordGenerator()

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

isConfigurationAcceptable

public boolean isConfigurationAcceptable(PasswordGeneratorConfig 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<PasswordGeneratorConfig>

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(PasswordGeneratorConfig 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<PasswordGeneratorConfig>

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.

generatePassword

public abstract ByteString generatePassword(Entry userEntry)
                                     throws LDAPException

Performs any processing which may be necessary to generate a user password.

Parameters:

userEntry - The entry of the user for whom to generate the password.

Returns:

The generated password.

Throws:

LDAPException - If a problem occurs while attempting to generate a password for the user.