<?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="debug-target" plural-name="debug-targets"
|
package="org.forgerock.opendj.admin"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
<adm:user-friendly-plural-name />
|
define the types of messages logged by the debug logPublisher.
|
</adm:synopsis>
|
<adm:description>
|
Debug targets allow for fine-grain control of which messages are logged
|
based on the package, class, or method that generated the message. Each
|
debug target configuration entry resides below the entry with RDN of
|
"cn=Debug Target" immediately below the parent ds-cfg-debug-log-publisher
|
entry.
|
</adm:description>
|
<adm:tag name="logging" />
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-debug-target</ldap:name>
|
<ldap:superior>top</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:property name="debug-scope" mandatory="true" read-only="true">
|
<adm:synopsis>
|
Specifies the fully-qualified <adm:product-name /> Java package, class, or method affected
|
by the settings in this target definition. Use the number
|
character (#) to separate the class name and the method name
|
(that is, org.opends.server.core.DirectoryServer#startUp).
|
</adm:synopsis>
|
<adm:syntax>
|
<adm:string>
|
<adm:pattern>
|
<adm:regex>
|
^([A-Za-z][A-Za-z0-9_]*\\.)*[A-Za-z][A-Za-z0-9_]*(#[A-Za-z][A-Za-z0-9_]*)?$
|
</adm:regex>
|
<adm:usage>STRING</adm:usage>
|
<adm:synopsis>
|
The fully-qualified <adm:product-name /> Java package, class, or method
|
name.
|
</adm:synopsis>
|
</adm:pattern>
|
</adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-debug-scope</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="debug-level" mandatory="true">
|
<adm:synopsis>
|
Specifies the lowest severity level of debug messages to log.
|
</adm:synopsis>
|
<adm:syntax>
|
<adm:enumeration>
|
<adm:value name="disabled">
|
<adm:synopsis>No messages are logged.</adm:synopsis>
|
</adm:value>
|
<adm:value name="error">
|
<adm:synopsis>
|
Messages with severity level of ERROR or higher are
|
logged.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="warning">
|
<adm:synopsis>
|
Messages with severity level of WARNING or higher are
|
logged.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="info">
|
<adm:synopsis>
|
Messages with severity level of INFO or higher are
|
logged.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="verbose">
|
<adm:synopsis>
|
Messages with severity level of VERBOSE or higher are
|
logged.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="all">
|
<adm:synopsis>
|
Messages with any severity level are logged.
|
</adm:synopsis>
|
</adm:value>
|
</adm:enumeration>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-debug-level</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="debug-category" multi-valued="true">
|
<adm:synopsis>
|
Specifies the debug message categories to be logged.
|
</adm:synopsis>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
Messages with any category are 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 thrown from method</adm:synopsis>
|
</adm:value>
|
</adm:enumeration>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-debug-category</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="omit-method-entry-arguments">
|
<adm:synopsis>
|
Specifies the property to indicate whether to include method arguments in debug
|
messages.
|
</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-omit-method-entry-arguments</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="omit-method-return-value">
|
<adm:synopsis>
|
Specifies the property to indicate whether to include the return value in debug
|
messages.
|
</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-omit-method-return-value</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="include-throwable-cause">
|
<adm:synopsis>
|
Specifies the property to indicate whether to include the cause of exceptions in
|
exception thrown and caught messages.
|
</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-include-throwable-cause</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="throwable-stack-frames">
|
<adm:synopsis>
|
Specifies the 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-throwable-stack-frames</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
