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

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends DebugTargetCfgClient,? extends DebugTargetCfg>	definition() Get the configuration definition associated with this Debug Target.
String	getDebugScope() Gets the "debug-scope" property.
int	getThrowableStackFrames() Gets the "throwable-stack-frames" property.
boolean	isDebugExceptionsOnly() Gets the "debug-exceptions-only" property.
Boolean	isEnabled() Gets the "enabled" 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	setDebugExceptionsOnly(Boolean value) Sets the "debug-exceptions-only" property.
void	setDebugScope(String value) Sets the "debug-scope" property.
void	setEnabled(boolean value) Sets the "enabled" property.
void	setIncludeThrowableCause(Boolean value) Sets the "include-throwable-cause" property.
void	setOmitMethodEntryArguments(Boolean value) Sets the "omit-method-entry-arguments" property.
void	setOmitMethodReturnValue(Boolean value) Sets the "omit-method-return-value" property.
void	setThrowableStackFrames(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.

isDebugExceptionsOnly

boolean isDebugExceptionsOnly()

Gets the "debug-exceptions-only" property.

Indicates whether only logs with exception should be logged.

Returns:

Returns the value of the "debug-exceptions-only" property.

setDebugExceptionsOnly

void setDebugExceptionsOnly(Boolean value)
                            throws PropertyException

Sets the "debug-exceptions-only" property.

Indicates whether only logs with exception should be logged.

Parameters:

value - The value of the "debug-exceptions-only" property.

Throws:

PropertyException - If the new value is invalid.

getDebugScope

String getDebugScope()

Gets the "debug-scope" property.

Specifies the fully-qualified OpenDJ 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(String value)
                   throws PropertyException,
                          PropertyException

Sets the "debug-scope" property.

Specifies the fully-qualified OpenDJ 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:

PropertyException - If the new value is invalid.

PropertyException - If this Debug Target is not being initialized.

isEnabled

Boolean isEnabled()

Gets the "enabled" property.

Indicates whether the Debug Target is enabled.

Returns:

Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws PropertyException

Sets the "enabled" property.

Indicates whether the Debug Target is enabled.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

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(Boolean value)
                              throws PropertyException

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:

PropertyException - 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(Boolean value)
                                 throws PropertyException

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:

PropertyException - 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(Boolean value)
                              throws PropertyException

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:

PropertyException - 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(Integer value)
                             throws PropertyException

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:

PropertyException - If the new value is invalid.