|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=false) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=false) @MetricsEngineExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class ScriptedAlertHandler
This class defines an API that must be implemented by scripted 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.
dsconfig create-alert-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 alert 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 alert handler. If multiple arguments should be provided to the alert handler, then the "
--set script-argument:{name=value}
" option should be
provided multiple times.
AlertHandler
Constructor Summary | |
---|---|
ScriptedAlertHandler()
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. |
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 |
---|
public ScriptedAlertHandler()
initializeAlertHandler
method.
Method Detail |
---|
public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeAlertHandler(ServerContext serverContext, AlertHandlerConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.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.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this alert
handler.public void finalizeAlertHandler()
public boolean isConfigurationAcceptable(AlertHandlerConfig config, com.unboundid.util.args.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 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)
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 abstract void handleAlert(AlertNotification alert)
alert
- The alert notification generated within the server.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |