org.opends.server.admin.std.server
Interface DebugTargetCfg

All Superinterfaces:
Configuration

public interface DebugTargetCfg
extends Configuration

A server-side interface for querying Debug Target settings.

Debug Targets define the types of messages logged by the debug logPublisher.


Method Summary
 void addChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener)
          Register to be notified when this Debug Target is changed.
 java.lang.Class<? extends DebugTargetCfg> configurationClass()
          Gets the configuration class associated with this Debug Target.
 java.util.SortedSet<DebugTargetCfgDefn.DebugCategory> getDebugCategory()
          Gets the "debug-category" property.
 DebugTargetCfgDefn.DebugLevel getDebugLevel()
          Gets the "debug-level" property.
 java.lang.String getDebugScope()
          Gets the "debug-scope" property.
 int getThrowableStackFrames()
          Gets the "throwable-stack-frames" property.
 boolean isIncludeThrowableCause()
          Gets the "include-throwable-cause" property.
 boolean isOmitMethodEntryArguments()
          Gets the "omit-method-entry-arguments" property.
 boolean isOmitMethodReturnValue()
          Gets the "omit-method-return-value" property.
 void removeChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener)
          Deregister an existing Debug Target configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends DebugTargetCfg> configurationClass()
Gets the configuration class associated with this Debug Target.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Debug Target.

addChangeListener

void addChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener)
Register to be notified when this Debug Target is changed.

Parameters:
listener - The Debug Target configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<DebugTargetCfg> listener)
Deregister an existing Debug Target configuration change listener.

Parameters:
listener - The Debug Target configuration change listener.

getDebugCategory

java.util.SortedSet<DebugTargetCfgDefn.DebugCategory> getDebugCategory()
Gets the "debug-category" property.

Specifies the debug message categories to be logged.

Returns:
Returns an unmodifiable set containing the values of the "debug-category" property.

getDebugLevel

DebugTargetCfgDefn.DebugLevel getDebugLevel()
Gets the "debug-level" property.

Specifies the lowest severity level of debug messages to log.

Returns:
Returns the value of the "debug-level" property.

getDebugScope

java.lang.String getDebugScope()
Gets the "debug-scope" property.

Specifies the fully-qualified OpenDS 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).

Returns:
Returns the value of the "debug-scope" property.

isIncludeThrowableCause

boolean isIncludeThrowableCause()
Gets the "include-throwable-cause" property.

Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.

Returns:
Returns the value of the "include-throwable-cause" property.

isOmitMethodEntryArguments

boolean isOmitMethodEntryArguments()
Gets the "omit-method-entry-arguments" property.

Specifies the property to indicate whether to include method arguments in debug messages.

Returns:
Returns the value of the "omit-method-entry-arguments" property.

isOmitMethodReturnValue

boolean isOmitMethodReturnValue()
Gets the "omit-method-return-value" property.

Specifies the property to indicate whether to include the return value in debug messages.

Returns:
Returns the value of the "omit-method-return-value" property.

getThrowableStackFrames

int getThrowableStackFrames()
Gets the "throwable-stack-frames" property.

Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.

Returns:
Returns the value of the "throwable-stack-frames" property.