Package org.forgerock.opendj.server.config.meta

Class DebugTargetCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>

org.forgerock.opendj.server.config.meta.DebugTargetCfgDefn

public final class DebugTargetCfgDefn
extends ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>

An interface for querying the Debug Target managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
DebugTargetCfgClient	createClientConfiguration(ManagedObject<? extends DebugTargetCfgClient> impl)	Creates a client configuration view of the provided managed object.
DebugTargetCfg	createServerConfiguration(ServerManagedObject<? extends DebugTargetCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getDebugExceptionsOnlyPropertyDefinition()	Get the "debug-exceptions-only" property definition.
StringPropertyDefinition	getDebugScopePropertyDefinition()	Get the "debug-scope" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
BooleanPropertyDefinition	getIncludeThrowableCausePropertyDefinition()	Get the "include-throwable-cause" property definition.
static DebugTargetCfgDefn	getInstance()	Get the Debug Target configuration definition singleton.
BooleanPropertyDefinition	getOmitMethodEntryArgumentsPropertyDefinition()	Get the "omit-method-entry-arguments" property definition.
BooleanPropertyDefinition	getOmitMethodReturnValuePropertyDefinition()	Get the "omit-method-return-value" property definition.
Class<DebugTargetCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
IntegerPropertyDefinition	getThrowableStackFramesPropertyDefinition()	Get the "throwable-stack-frames" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static DebugTargetCfgDefn getInstance()

Get the Debug Target configuration definition singleton.

Returns:

Returns the Debug Target configuration definition singleton.

createClientConfiguration

public DebugTargetCfgClient createClientConfiguration(ManagedObject<? extends DebugTargetCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public DebugTargetCfg createServerConfiguration(ServerManagedObject<? extends DebugTargetCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<DebugTargetCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getDebugExceptionsOnlyPropertyDefinition

public BooleanPropertyDefinition getDebugExceptionsOnlyPropertyDefinition()

Get the "debug-exceptions-only" property definition.

Indicates whether only logs with exception should be logged.

Returns:

Returns the "debug-exceptions-only" property definition.

getDebugScopePropertyDefinition

public StringPropertyDefinition getDebugScopePropertyDefinition()

Get the "debug-scope" property definition.

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 "debug-scope" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Debug Target is enabled.

Returns:

Returns the "enabled" property definition.

getIncludeThrowableCausePropertyDefinition

public BooleanPropertyDefinition getIncludeThrowableCausePropertyDefinition()

Get the "include-throwable-cause" property definition.

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

Returns:

Returns the "include-throwable-cause" property definition.

getOmitMethodEntryArgumentsPropertyDefinition

public BooleanPropertyDefinition getOmitMethodEntryArgumentsPropertyDefinition()

Get the "omit-method-entry-arguments" property definition.

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

Returns:

Returns the "omit-method-entry-arguments" property definition.

getOmitMethodReturnValuePropertyDefinition

public BooleanPropertyDefinition getOmitMethodReturnValuePropertyDefinition()

Get the "omit-method-return-value" property definition.

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

Returns:

Returns the "omit-method-return-value" property definition.

getThrowableStackFramesPropertyDefinition

public IntegerPropertyDefinition getThrowableStackFramesPropertyDefinition()

Get the "throwable-stack-frames" property definition.

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 "throwable-stack-frames" property definition.