|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DebugTargetCfgClient
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 |
---|
ManagedObjectDefinition<? extends DebugTargetCfgClient,? extends DebugTargetCfg> definition()
definition
in interface ConfigurationClient
java.util.SortedSet<DebugTargetCfgDefn.DebugCategory> getDebugCategory()
Specifies the debug message categories to be logged.
void setDebugCategory(java.util.Collection<DebugTargetCfgDefn.DebugCategory> values) throws IllegalPropertyValueException
Specifies the debug message categories to be logged.
values
- The values of the "debug-category" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.DebugTargetCfgDefn.DebugLevel getDebugLevel()
Specifies the lowest severity level of debug messages to log.
void setDebugLevel(DebugTargetCfgDefn.DebugLevel value) throws IllegalPropertyValueException
Specifies the lowest severity level of debug messages to log.
value
- The value of the "debug-level" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getDebugScope()
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).
void setDebugScope(java.lang.String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "debug-scope" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Debug Target is not being initialized.boolean isIncludeThrowableCause()
Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.
void setIncludeThrowableCause(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.
value
- The value of the "include-throwable-cause" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isOmitMethodEntryArguments()
Specifies the property to indicate whether to include method arguments in debug messages.
void setOmitMethodEntryArguments(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies the property to indicate whether to include method arguments in debug messages.
value
- The value of the "omit-method-entry-arguments" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isOmitMethodReturnValue()
Specifies the property to indicate whether to include the return value in debug messages.
void setOmitMethodReturnValue(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies the property to indicate whether to include the return value in debug messages.
value
- The value of the "omit-method-return-value" property.
IllegalPropertyValueException
- If the new value is invalid.int getThrowableStackFrames()
Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.
void setThrowableStackFrames(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.
value
- The value of the "throwable-stack-frames" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |