DebugLogPublisherConfiguration.xml revision 188a85993cf1cf9925338176e5f27b95a5891c50
<?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
! 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
!
!
! Portions Copyright 2007 Sun Microsystems, Inc.
! -->
<adm:managed-object name="debug-log-publisher"
plural-name="debug-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 debug log messages from the debug
logger to a destination.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-debug-log-publisher</ldap:name>
<ldap:superior>ds-cfg-log-publisher</ldap:superior>
</ldap:object-class>
</adm:profile>
<adm:relation name="debug-target">
<adm:one-to-many naming-property="debug-scope" />
<adm:profile name="ldap">
<ldap:rdn-sequence>cn=Debug Targets</ldap:rdn-sequence>
</adm:profile>
<adm:profile name="cli">
<cli:relation>
<cli:default-property name="debug-level" />
<cli:default-property name="debug-category" />
</cli:relation>
</adm:profile>
</adm:relation>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
The fully-qualified name of the Java class that provides the
<adm:user-friendly-name />
implementation.
</adm:synopsis>
<adm:syntax>
<adm:java-class>
<adm:instance-of>
</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="default-debug-level" mandatory="true">
<adm:synopsis>
The lowest severity level of debug messages to log when none of
the defined targets match the message.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>error</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:enumeration>
<adm:value name="disabled">
<adm:synopsis>No messages will be logged.</adm:synopsis>
</adm:value>
<adm:value name="error">
<adm:synopsis>
Messages with severity level of ERROR or higher will be
logged.
</adm:synopsis>
</adm:value>
<adm:value name="warning">
<adm:synopsis>
Messages with severity level of WARNING or higher will be
logged.
</adm:synopsis>
</adm:value>
<adm:value name="info">
<adm:synopsis>
Messages with severity level of INFO or higher will be
logged.
</adm:synopsis>
</adm:value>
<adm:value name="verbose">
<adm:synopsis>
Messages with severity level of VERBOSE or higher will be
logged.
</adm:synopsis>
</adm:value>
<adm:value name="all">
<adm:synopsis>
Messages with any severity level will be logged.
</adm:synopsis>
</adm:value>
</adm:enumeration>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-default-debug-level</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="default-debug-category" multi-valued="true">
<adm:synopsis>
The debug message categories to be logged when none of the defined
targets match the message.
</adm:synopsis>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
Messages with any category will be logged if they have a
sufficient debug level.
</adm:synopsis>
</adm:alias>
</adm:default-behavior>
<adm:syntax>
<adm:enumeration>
<adm:value name="caught">
<adm:synopsis>Exception caught.</adm:synopsis>
</adm:value>
<adm:value name="constructor">
<adm:synopsis>Constructor entry.</adm:synopsis>
</adm:value>
<adm:value name="data">
<adm:synopsis>Raw data dump.</adm:synopsis>
</adm:value>
<adm:value name="database-access">
<adm:synopsis>Access to a backend database.</adm:synopsis>
</adm:value>
<adm:value name="enter">
<adm:synopsis>Method entry.</adm:synopsis>
</adm:value>
<adm:value name="exit">
<adm:synopsis>Method exit.</adm:synopsis>
</adm:value>
<adm:value name="message">
<adm:synopsis>Arbitrary debug message.</adm:synopsis>
</adm:value>
<adm:value name="protocol">
<adm:synopsis>Protocol element dump.</adm:synopsis>
</adm:value>
<adm:value name="thrown">
<adm:synopsis>Exception throw from method.</adm:synopsis>
</adm:value>
</adm:enumeration>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-default-debug-category</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="default-omit-method-entry-arguments">
<adm:synopsis>
Property to indicate whether to include method arguments in debug
messages logged by default.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>false</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:boolean />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>
ds-cfg-default-omit-method-entry-arguments
</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="default-omit-method-return-value">
<adm:synopsis>
Property to indicate whether to include the return value in debug
messages logged by default.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>false</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:boolean />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-default-omit-method-return-value</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="default-include-throwable-cause">
<adm:synopsis>
Property to indicate whether to include the cause of exceptions in
exception thrown and caught messages logged by default.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>false</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:boolean />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-default-include-throwable-cause</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="default-throwable-stack-frames">
<adm:synopsis>
Property to indicate the number of stack frames to include in the
stack trace for method entry and exception thrown messages.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>0</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:integer lower-limit="0" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-default-throwable-stack-frames</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
</adm:managed-object>