org.opends.server.admin.std.client
Interface DebugTargetCfgClient

All Superinterfaces:
ConfigurationClient

public interface DebugTargetCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Debug Target settings.

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


Method Summary
 ManagedObjectDefinition<? extends DebugTargetCfgClient,? extends DebugTargetCfg> definition()
          Get the configuration definition 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 setDebugCategory(java.util.Collection<DebugTargetCfgDefn.DebugCategory> values)
          Sets the "debug-category" property.
 void setDebugLevel(DebugTargetCfgDefn.DebugLevel value)
          Sets the "debug-level" property.
 void setDebugScope(java.lang.String value)
          Sets the "debug-scope" property.
 void setIncludeThrowableCause(java.lang.Boolean value)
          Sets the "include-throwable-cause" property.
 void setOmitMethodEntryArguments(java.lang.Boolean value)
          Sets the "omit-method-entry-arguments" property.
 void setOmitMethodReturnValue(java.lang.Boolean value)
          Sets the "omit-method-return-value" property.
 void setThrowableStackFrames(java.lang.Integer value)
          Sets the "throwable-stack-frames" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends DebugTargetCfgClient,? extends DebugTargetCfg> definition()
Get the configuration definition associated with this Debug Target.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Debug Target.

getDebugCategory

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

Specifies the debug message categories to be logged.

Returns:
Returns the values of the "debug-category" property.

setDebugCategory

void setDebugCategory(java.util.Collection<DebugTargetCfgDefn.DebugCategory> values)
                      throws IllegalPropertyValueException
Sets the "debug-category" property.

Specifies the debug message categories to be logged.

Parameters:
values - The values of the "debug-category" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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.

setDebugLevel

void setDebugLevel(DebugTargetCfgDefn.DebugLevel value)
                   throws IllegalPropertyValueException
Sets the "debug-level" property.

Specifies the lowest severity level of debug messages to log.

Parameters:
value - The value of the "debug-level" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setDebugScope

void setDebugScope(java.lang.String value)
                   throws IllegalPropertyValueException,
                          PropertyIsReadOnlyException
Sets 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).

This property is read-only and can only be modified during creation of a Debug Target.

Parameters:
value - The value of the "debug-scope" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Debug Target is not being initialized.

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.

setIncludeThrowableCause

void setIncludeThrowableCause(java.lang.Boolean value)
                              throws IllegalPropertyValueException
Sets the "include-throwable-cause" property.

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

Parameters:
value - The value of the "include-throwable-cause" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setOmitMethodEntryArguments

void setOmitMethodEntryArguments(java.lang.Boolean value)
                                 throws IllegalPropertyValueException
Sets the "omit-method-entry-arguments" property.

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

Parameters:
value - The value of the "omit-method-entry-arguments" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setOmitMethodReturnValue

void setOmitMethodReturnValue(java.lang.Boolean value)
                              throws IllegalPropertyValueException
Sets the "omit-method-return-value" property.

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

Parameters:
value - The value of the "omit-method-return-value" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setThrowableStackFrames

void setThrowableStackFrames(java.lang.Integer value)
                             throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "throwable-stack-frames" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.