001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.server; 017 018 019 020import org.forgerock.opendj.config.Configuration; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Debug Target settings. 027 * <p> 028 * Debug Targets define the types of messages logged by the debug 029 * logPublisher. 030 */ 031public interface DebugTargetCfg extends Configuration { 032 033 /** 034 * Gets the configuration class associated with this Debug Target. 035 * 036 * @return Returns the configuration class associated with this Debug Target. 037 */ 038 Class<? extends DebugTargetCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this Debug Target is changed. 044 * 045 * @param listener 046 * The Debug Target configuration change listener. 047 */ 048 void addChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener); 049 050 051 052 /** 053 * Deregister an existing Debug Target configuration change listener. 054 * 055 * @param listener 056 * The Debug Target configuration change listener. 057 */ 058 void removeChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener); 059 060 061 062 /** 063 * Gets the "debug-exceptions-only" property. 064 * <p> 065 * Indicates whether only logs with exception should be logged. 066 * 067 * @return Returns the value of the "debug-exceptions-only" property. 068 */ 069 boolean isDebugExceptionsOnly(); 070 071 072 073 /** 074 * Gets the "debug-scope" property. 075 * <p> 076 * Specifies the fully-qualified OpenDJ Java package, class, or 077 * method affected by the settings in this target definition. Use the 078 * number character (#) to separate the class name and the method 079 * name (that is, org.opends.server.core.DirectoryServer#startUp). 080 * 081 * @return Returns the value of the "debug-scope" property. 082 */ 083 String getDebugScope(); 084 085 086 087 /** 088 * Gets the "enabled" property. 089 * <p> 090 * Indicates whether the Debug Target is enabled. 091 * 092 * @return Returns the value of the "enabled" property. 093 */ 094 boolean isEnabled(); 095 096 097 098 /** 099 * Gets the "include-throwable-cause" property. 100 * <p> 101 * Specifies the property to indicate whether to include the cause 102 * of exceptions in exception thrown and caught messages. 103 * 104 * @return Returns the value of the "include-throwable-cause" property. 105 */ 106 boolean isIncludeThrowableCause(); 107 108 109 110 /** 111 * Gets the "omit-method-entry-arguments" property. 112 * <p> 113 * Specifies the property to indicate whether to include method 114 * arguments in debug messages. 115 * 116 * @return Returns the value of the "omit-method-entry-arguments" property. 117 */ 118 boolean isOmitMethodEntryArguments(); 119 120 121 122 /** 123 * Gets the "omit-method-return-value" property. 124 * <p> 125 * Specifies the property to indicate whether to include the return 126 * value in debug messages. 127 * 128 * @return Returns the value of the "omit-method-return-value" property. 129 */ 130 boolean isOmitMethodReturnValue(); 131 132 133 134 /** 135 * Gets the "throwable-stack-frames" property. 136 * <p> 137 * Specifies the property to indicate the number of stack frames to 138 * include in the stack trace for method entry and exception thrown 139 * messages. 140 * 141 * @return Returns the value of the "throwable-stack-frames" property. 142 */ 143 int getThrowableStackFrames(); 144 145}