com.unboundid.directory.sdk.ds.scripting

Class ScriptedAccountStatusNotificationHandler

java.lang.Object

com.unboundid.directory.sdk.ds.scripting.ScriptedAccountStatusNotificationHandler

All Implemented Interfaces:

Configurable, Reconfigurable<AccountStatusNotificationHandlerConfig>

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

This class defines an API that must be implemented by scripted extensions which have the ability to process notifications about events that occur that could change the status of a user account. For example, account status notification handlers may be used to notify the end user and/or administrators of a change to that user's account. The kinds of events that may trigger account status notifications are defined in the AccountStatusNotificationType enum, and include things like user accounts locked due to authentication failures, password expiration errors and warnings, and administrative password resets.

Configuring Groovy-Scripted Account Status Notification Handlers

In order to configure a scripted account status notification handler based on this API and written in the Groovy scripting language, use a command like:

      dsconfig create-account-status-notification-handler \
           --handler-name "{handler-name}" \
           --type groovy-scripted \
           --set enabled:true \
           --set "script-class:{class-name}" \
           --set "script-argument:{name=value}"
 

where "{handler-name}" is the name to use for the account status notification handler 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 account status notification handler. If multiple arguments should be provided to the account status notification handler, then the "--set script-argument:{name=value}" option should be provided multiple times.

See Also:

AccountStatusNotificationHandler

Constructor Summary

Constructors

Constructor and Description
ScriptedAccountStatusNotificationHandler() Creates a new instance of this account status notification handler.

Method Summary

Modifier and Type	Method and Description
com.unboundid.ldap.sdk.ResultCode	applyConfiguration(AccountStatusNotificationHandlerConfig config, com.unboundid.util.args.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(com.unboundid.util.args.ArgumentParser parser) Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeAccountStatusNotificationHandler() Performs any cleanup which may be necessary when this account status notification handler is to be taken out of service.
abstract void	handleStatusNotification(AccountStatusNotification notification) Performs any processing that may be necessary in conjunction with the provided account status notification.
void	initializeAccountStatusNotificationHandler(DirectoryServerContext serverContext, AccountStatusNotificationHandlerConfig config, com.unboundid.util.args.ArgumentParser parser) Initializes this account status notification handler.
boolean	isConfigurationAcceptable(AccountStatusNotificationHandlerConfig config, com.unboundid.util.args.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

ScriptedAccountStatusNotificationHandler

public ScriptedAccountStatusNotificationHandler()

Creates a new instance of this account status notification handler. All account status notification handler implementations must include a default constructor, but any initialization should generally be done in the initializeAccountStatusNotificationHandler method.

Method Detail

defineConfigArguments

public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
                           throws com.unboundid.util.args.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:

com.unboundid.util.args.ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeAccountStatusNotificationHandler

public void initializeAccountStatusNotificationHandler(DirectoryServerContext serverContext,
                                                       AccountStatusNotificationHandlerConfig config,
                                                       com.unboundid.util.args.ArgumentParser parser)
                                                throws com.unboundid.ldap.sdk.LDAPException

Initializes this account status notification handler.

Parameters:

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

config - The general configuration for this account status notification handler.

parser - The argument parser which has been initialized from the configuration for this account status notification handler.

Throws:

com.unboundid.ldap.sdk.LDAPException - If a problem occurs while initializing this account status notification handler.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(AccountStatusNotificationHandlerConfig config,
                                         com.unboundid.util.args.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<AccountStatusNotificationHandlerConfig>

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 com.unboundid.ldap.sdk.ResultCode applyConfiguration(AccountStatusNotificationHandlerConfig config,
                                                            com.unboundid.util.args.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<AccountStatusNotificationHandlerConfig>

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.

finalizeAccountStatusNotificationHandler

public void finalizeAccountStatusNotificationHandler()

Performs any cleanup which may be necessary when this account status notification handler is to be taken out of service.

handleStatusNotification

public abstract void handleStatusNotification(AccountStatusNotification notification)

Performs any processing that may be necessary in conjunction with the provided account status notification.

Parameters:

notification - The account status notification to be processed.