Package com.unboundid.directory.sdk.ds.api

Class AccountStatusNotificationHandler

java.lang.Object

com.unboundid.directory.sdk.ds.api.AccountStatusNotificationHandler

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<AccountStatusNotificationHandlerConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by 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 Account Status Notification Handlers

In order to configure an account status notification handler created using this API, use a command like:

      dsconfig create-account-status-notification-handler \
           --handler-name "{handler-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-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 Java class that extends com.unboundid.directory.sdk.ds.api.AccountStatusNotificationHandler, 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 handler, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(AccountStatusNotificationHandlerConfig 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	finalizeAccountStatusNotificationHandler()	Performs any cleanup which may be necessary when this account status notification handler 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 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, ArgumentParser parser)	Initializes this account status notification handler.
boolean	isConfigurationAcceptable(AccountStatusNotificationHandlerConfig 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

AccountStatusNotificationHandler

public AccountStatusNotificationHandler()

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

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.

initializeAccountStatusNotificationHandler

public void initializeAccountStatusNotificationHandler(DirectoryServerContext serverContext,
                                                       AccountStatusNotificationHandlerConfig config,
                                                       ArgumentParser parser)
                                                throws 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:

LDAPException - If a problem occurs while initializing this account status notificationHandler.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(AccountStatusNotificationHandlerConfig 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<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 ResultCode applyConfiguration(AccountStatusNotificationHandlerConfig 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<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.

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.