<?xml version="1.0" encoding="utf-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
! add the following below this CDDL HEADER, with the fields enclosed
|
! by brackets "[]" replaced with your own identifying information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2008 Sun Microsystems, Inc.
|
! Portions Copyright 2011 ForgeRock AS
|
! -->
|
<adm:managed-object name="alert-handler" plural-name="alert-handlers"
|
package="org.opends.server.admin.std"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap"
|
xmlns:cli="http://www.opends.org/admin-cli">
|
<adm:synopsis>
|
<adm:user-friendly-plural-name />
|
are used to notify administrators of significant problems or notable
|
events that occur in the <adm:product-name /> directory server.
|
</adm:synopsis>
|
<adm:tag name="core-server" />
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-alert-handler</ldap:name>
|
<ldap:superior>top</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:profile name="cli">
|
<cli:managed-object custom="true" />
|
</adm:profile>
|
<adm:property name="enabled" mandatory="true">
|
<adm:synopsis>
|
Indicates whether the
|
<adm:user-friendly-name />
|
is enabled.
|
</adm:synopsis>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-enabled</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="java-class" mandatory="true">
|
<adm:synopsis>
|
Specifies the fully-qualified name of the Java class that provides the
|
<adm:user-friendly-name />
|
implementation.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:syntax>
|
<adm:java-class>
|
<adm:instance-of>
|
org.opends.server.api.AlertHandler
|
</adm:instance-of>
|
</adm:java-class>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-java-class</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="enabled-alert-type" multi-valued="true">
|
<adm:synopsis>
|
Specifies the names of the alert types that are enabled for this
|
alert handler.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
All alerts with types not included in the set of disabled
|
alert types are allowed.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-enabled-alert-type</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="disabled-alert-type" multi-valued="true">
|
<adm:synopsis>
|
Specifies the names of the alert types that are disabled for this
|
alert handler.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
If there is a set of enabled alert types, then only alerts
|
with one of those types are allowed. Otherwise, all alerts
|
are allowed.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-disabled-alert-type</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
