<?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 2013 ForgeRock AS
|
! -->
|
<adm:managed-object name="error-log-publisher"
|
plural-name="error-log-publishers"
|
package="org.opends.server.admin.std" extends="log-publisher"
|
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 responsible for distributing error log messages from the error
|
logger to a destination.
|
</adm:synopsis>
|
<adm:description>
|
Error log messages provide information about any warnings, errors,
|
or significant events that are encountered during server processing.
|
</adm:description>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-error-log-publisher</ldap:name>
|
<ldap:superior>ds-cfg-log-publisher</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:profile name="cli">
|
<cli:managed-object custom="true" />
|
</adm:profile>
|
<adm:property-override name="java-class">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>org.opends.server.api.ErrorLogPublisher</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="default-severity" multi-valued="true">
|
<adm:synopsis>
|
Specifies the default severity levels for the logger.
|
</adm:synopsis>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>fatal-error</adm:value>
|
<adm:value>severe-warning</adm:value>
|
<adm:value>severe-error</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:enumeration>
|
<adm:value name="all">
|
<adm:synopsis>
|
Messages of all severity levels are logged.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="none">
|
<adm:synopsis>
|
No messages of any severity are logged by default. This
|
value is intended to be used in conjunction with the
|
override-severity property to define an error logger that
|
will publish no error message beside the errors of a given
|
category.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="fatal-error">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about fatal errors which may force the
|
server to shut down or operate in a significantly degraded
|
state.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="info">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about significant events within the
|
server that are not warnings or errors.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="mild-error">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about mild (recoverable) errors
|
encountered during processing.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="mild-warning">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about mild warnings triggered during
|
processing.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="notice">
|
<adm:synopsis>
|
The error log severity that is used for the most
|
important informational messages (i.e., information that
|
should almost always be logged but is not associated with a
|
warning or error condition).
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="severe-error">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about severe errors encountered during
|
processing.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="severe-warning">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide information about severe warnings triggered during
|
processing.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="debug">
|
<adm:synopsis>
|
The error log severity that is used for messages that
|
provide debugging information triggered during processing.
|
</adm:synopsis>
|
</adm:value>
|
</adm:enumeration>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-default-severity</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="override-severity" multi-valued="true">
|
<adm:TODO>
|
This should be split into per-category properties whose value
|
defaults to the default-severity. See issue 2503.
|
</adm:TODO>
|
<adm:synopsis>
|
Specifies the override severity levels for the logger
|
based on the category of the messages.
|
</adm:synopsis>
|
<adm:description>
|
Each override severity level should include the category and the
|
severity levels to log for that category, for example,
|
core=mild-error,info,mild-warning. Valid categories are: core,
|
extensions, protocol, config, log, util, schema, plugin, jeb,
|
backend, tools, task, access-control, admin, sync, version,
|
quicksetup, admin-tool, dsconfig, user-defined. Valid severities
|
are: all, fatal-error, info, mild-error, mild-warning, notice,
|
severe-error, severe-warning, debug.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
All messages with the default severity levels are logged.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string>
|
<adm:pattern>
|
<adm:regex>.*</adm:regex>
|
<adm:usage>STRING</adm:usage>
|
<adm:synopsis>
|
A string in the form category=severity1,severity2...
|
</adm:synopsis>
|
</adm:pattern>
|
</adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-override-severity</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
