Alert Handler

This is an abstract object type that cannot be instantiated.

Alert Handlers are used to notify administrators of significant problems or notable events that occur in the OpenDJ directory server.

Alert Handlers

The following Alert Handlers are available:

These Alert Handlers inherit the properties described below.

Alert Handler Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

disabled-alert-type
enabled
enabled-alert-type
java-class

Basic Properties

Use the --advanced option to access advanced properties.

disabled-alert-type

Synopsis

Specifies the names of the alert types that are disabled for this alert handler.

Description

If there are any values for this attribute, then no alerts with any of the specified types are allowed. If there are no values for this attribute, then only alerts with a type included in the set of enabled alert types are allowed, or if there are no values for the enabled alert types option, then all alert types are allowed.

Default Value

If there is a set of enabled alert types, then only alerts with one of those types are allowed. Otherwise, all alerts are allowed.

Allowed Values

A string.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

enabled

Synopsis

Indicates whether the Alert Handler is enabled.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

enabled-alert-type

Synopsis

Specifies the names of the alert types that are enabled for this alert handler.

Description

If there are any values for this attribute, then only alerts with one of the specified types are allowed (unless they are also included in the disabled alert types). If there are no values for this attribute, then any alert with a type not included in the list of disabled alert types is allowed.

Default Value

All alerts with types not included in the set of disabled alert types are allowed.

Allowed Values

A string.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

java-class

Synopsis

Specifies the fully-qualified name of the Java class that provides the Alert Handler implementation.

Default Value

None

Allowed Values

A Java class that extends or implements:

  • org.opends.server.api.AlertHandler

Multi-valued

No

Required

Yes

Admin Action Required

The object must be disabled and re-enabled for changes to take effect.

Advanced

No

Read-Only

No