com.unboundid.directory.sdk.common.api
Class AlertHandler

java.lang.Object
  com.unboundid.directory.sdk.common.api.AlertHandler

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<AlertHandlerConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions which will be invoked whenever an administrative alert is generated within the server. Administrative alerts may be used to notify administrators whenever a significant error, warning, or other type of event occurs within the server. Alert handlers may be used to help ensure that those notifications are made available to administrators in an appropriate manner.

Each alert handler may be configured so that it will only be invoked for certain types of alerts, either based on the specific alert type or based on the alert severity. This is handled automatically by the server, so individual alert handler implementations do not need to attempt to perform that filtering on their own. However, they may perform additional processing if desired to further narrow the set of alerts that should be made available to administrators.

Configuring Alert Handlers

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

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

See Also:

ScriptedAlertHandler

Constructor Summary

AlertHandler()
Creates a new instance of this alert handler.

Method Summary

com.unboundid.ldap.sdk.ResultCode	applyConfiguration(AlertHandlerConfig 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	finalizeAlertHandler() Performs any cleanup which may be necessary when this alert 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	handleAlert(AlertNotification alert) Performs any processing which may be necessary to handle the provided alert notification.
void	initializeAlertHandler(ServerContext serverContext, AlertHandlerConfig config, com.unboundid.util.args.ArgumentParser parser) Initializes this alert handler.
boolean	isConfigurationAcceptable(AlertHandlerConfig 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

AlertHandler

public AlertHandler()

Creates a new instance of this alert handler. All alert handler implementations must include a default constructor, but any initialization should generally be done in the initializeAlertHandler 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(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.

initializeAlertHandler

public void initializeAlertHandler(ServerContext serverContext,
                                   AlertHandlerConfig config,
                                   com.unboundid.util.args.ArgumentParser parser)
                            throws com.unboundid.ldap.sdk.LDAPException

Initializes this alert handler.

Parameters:

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

config - The general configuration for this alert handler.

parser - The argument parser which has been initialized from the configuration for this alert handler.

Throws:

com.unboundid.ldap.sdk.LDAPException - If a problem occurs while initializing this alert handler.

isConfigurationAcceptable

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

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

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.

finalizeAlertHandler

public void finalizeAlertHandler()

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

handleAlert

public abstract void handleAlert(AlertNotification alert)

Performs any processing which may be necessary to handle the provided alert notification.

Parameters:

alert - The alert notification generated within the server.

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.