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

Class DebugLogPublisherCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<DebugLogPublisherCfgClient,DebugLogPublisherCfg>

org.forgerock.opendj.server.config.meta.DebugLogPublisherCfgDefn

public final class DebugLogPublisherCfgDefn
extends ManagedObjectDefinition<DebugLogPublisherCfgClient,DebugLogPublisherCfg>

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

Debug Log Publishers are responsible for distributing debug log messages from the debug logger to a destination.

Method Summary

Modifier and Type	Method	Description
DebugLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends DebugLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
DebugLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends DebugLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
InstantiableRelationDefinition<DebugTargetCfgClient,DebugTargetCfg>	getDebugTargetsRelationDefinition()	Get the "debug-targets" relation definition.
BooleanPropertyDefinition	getDefaultDebugExceptionsOnlyPropertyDefinition()	Get the "default-debug-exceptions-only" property definition.
BooleanPropertyDefinition	getDefaultIncludeThrowableCausePropertyDefinition()	Get the "default-include-throwable-cause" property definition.
BooleanPropertyDefinition	getDefaultOmitMethodEntryArgumentsPropertyDefinition()	Get the "default-omit-method-entry-arguments" property definition.
BooleanPropertyDefinition	getDefaultOmitMethodReturnValuePropertyDefinition()	Get the "default-omit-method-return-value" property definition.
IntegerPropertyDefinition	getDefaultThrowableStackFramesPropertyDefinition()	Get the "default-throwable-stack-frames" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static DebugLogPublisherCfgDefn	getInstance()	Get the Debug Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<DebugLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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 DebugLogPublisherCfgDefn getInstance()

Get the Debug Log Publisher configuration definition singleton.

Returns:

Returns the Debug Log Publisher configuration definition singleton.

createClientConfiguration

public DebugLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends DebugLogPublisherCfgClient> 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<DebugLogPublisherCfgClient,DebugLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<DebugLogPublisherCfgClient,DebugLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<DebugLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<DebugLogPublisherCfgClient,DebugLogPublisherCfg>

Returns:

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

getDefaultDebugExceptionsOnlyPropertyDefinition

public BooleanPropertyDefinition getDefaultDebugExceptionsOnlyPropertyDefinition()

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

Indicates whether only logs with exception should be logged.

Returns:

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

getDefaultIncludeThrowableCausePropertyDefinition

public BooleanPropertyDefinition getDefaultIncludeThrowableCausePropertyDefinition()

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

Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.

Returns:

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

getDefaultOmitMethodEntryArgumentsPropertyDefinition

public BooleanPropertyDefinition getDefaultOmitMethodEntryArgumentsPropertyDefinition()

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

Indicates whether to include method arguments in debug messages logged by default.

Returns:

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

getDefaultOmitMethodReturnValuePropertyDefinition

public BooleanPropertyDefinition getDefaultOmitMethodReturnValuePropertyDefinition()

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

Indicates whether to include the return value in debug messages logged by default.

Returns:

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

getDefaultThrowableStackFramesPropertyDefinition

public IntegerPropertyDefinition getDefaultThrowableStackFramesPropertyDefinition()

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

Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.

Returns:

Returns the "default-throwable-stack-frames" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Debug Log Publisher is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

The fully-qualified name of the Java class that provides the Debug Log Publisher implementation.

Returns:

Returns the "java-class" property definition.

getDebugTargetsRelationDefinition

public InstantiableRelationDefinition<DebugTargetCfgClient,DebugTargetCfg> getDebugTargetsRelationDefinition()

Get the "debug-targets" relation definition.

Returns:

Returns the "debug-targets" relation definition.