@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=false) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=false) @MetricsEngineExtension @BrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class AlertHandler extends java.lang.Object implements UnboundIDExtension, Reconfigurable<AlertHandlerConfig>, ExampleUsageProvider
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.ScriptedAlertHandler
Constructor and Description |
---|
AlertHandler()
Creates a new instance of this alert handler.
|
Modifier and Type | Method and Description |
---|---|
ResultCode |
applyConfiguration(AlertHandlerConfig 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 |
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,
ArgumentParser parser)
Initializes this alert handler.
|
boolean |
isConfigurationAcceptable(AlertHandlerConfig 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.
|
public AlertHandler()
initializeAlertHandler
method.public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(ArgumentParser parser) throws ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeAlertHandler(ServerContext serverContext, AlertHandlerConfig config, ArgumentParser parser) throws LDAPException
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.LDAPException
- If a problem occurs while initializing this alert
handler.public boolean isConfigurationAcceptable(AlertHandlerConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<AlertHandlerConfig>
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.true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public ResultCode applyConfiguration(AlertHandlerConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<AlertHandlerConfig>
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.SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeAlertHandler()
public abstract void handleAlert(AlertNotification alert)
alert
- The alert notification generated within the server.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.