org.opends.server.admin.std.meta
Class DebugTargetCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<DebugTargetCfgClient,DebugTargetCfg>
          extended by org.opends.server.admin.std.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.


Nested Class Summary
static class DebugTargetCfgDefn.DebugCategory
          Defines the set of permissable values for the "debug-category" property.
static class DebugTargetCfgDefn.DebugLevel
          Defines the set of permissable values for the "debug-level" property.
 
Method Summary
 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.
 EnumPropertyDefinition<DebugTargetCfgDefn.DebugCategory> getDebugCategoryPropertyDefinition()
          Get the "debug-category" property definition.
 EnumPropertyDefinition<DebugTargetCfgDefn.DebugLevel> getDebugLevelPropertyDefinition()
          Get the "debug-level" property definition.
 StringPropertyDefinition getDebugScopePropertyDefinition()
          Get the "debug-scope" 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.
 java.lang.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.opends.server.admin.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)
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)
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 java.lang.Class<DebugTargetCfg> getServerConfigurationClass()
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.

getDebugCategoryPropertyDefinition

public EnumPropertyDefinition<DebugTargetCfgDefn.DebugCategory> getDebugCategoryPropertyDefinition()
Get the "debug-category" property definition.

Specifies the debug message categories to be logged.

Returns:
Returns the "debug-category" property definition.

getDebugLevelPropertyDefinition

public EnumPropertyDefinition<DebugTargetCfgDefn.DebugLevel> getDebugLevelPropertyDefinition()
Get the "debug-level" property definition.

Specifies the lowest severity level of debug messages to log.

Returns:
Returns the "debug-level" property definition.

getDebugScopePropertyDefinition

public StringPropertyDefinition getDebugScopePropertyDefinition()
Get the "debug-scope" property definition.

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