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

Class FileBasedDebugLogPublisherCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>

org.forgerock.opendj.server.config.meta.FileBasedDebugLogPublisherCfgDefn

public final class FileBasedDebugLogPublisherCfgDefn
extends ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>

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

File Based Debug Log Publishers publish debug messages to the file system.

Method Summary

Modifier and Type	Method	Description
FileBasedDebugLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends FileBasedDebugLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
FileBasedDebugLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends FileBasedDebugLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getAppendPropertyDefinition()	Get the "append" property definition.
BooleanPropertyDefinition	getAsynchronousPropertyDefinition()	Get the "asynchronous" property definition.
BooleanPropertyDefinition	getAutoFlushPropertyDefinition()	Get the "auto-flush" property definition.
SizePropertyDefinition	getBufferSizePropertyDefinition()	Get the "buffer-size" property definition.
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 FileBasedDebugLogPublisherCfgDefn	getInstance()	Get the File Based Debug Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getLogFilePermissionsPropertyDefinition()	Get the "log-file-permissions" property definition.
StringPropertyDefinition	getLogFilePropertyDefinition()	Get the "log-file" property definition.
IntegerPropertyDefinition	getQueueSizePropertyDefinition()	Get the "queue-size" property definition.
AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>	getRetentionPolicyPropertyDefinition()	Get the "retention-policy" property definition.
AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg>	getRotationPolicyPropertyDefinition()	Get the "rotation-policy" property definition.
Class<FileBasedDebugLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
DurationPropertyDefinition	getTimeIntervalPropertyDefinition()	Get the "time-interval" 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 FileBasedDebugLogPublisherCfgDefn getInstance()

Get the File Based Debug Log Publisher configuration definition singleton.

Returns:

Returns the File Based Debug Log Publisher configuration definition singleton.

createClientConfiguration

public FileBasedDebugLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends FileBasedDebugLogPublisherCfgClient> 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<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FileBasedDebugLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>

Returns:

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

getAppendPropertyDefinition

public BooleanPropertyDefinition getAppendPropertyDefinition()

Get the "append" property definition.

Specifies whether to append to existing log files.

Returns:

Returns the "append" property definition.

getAsynchronousPropertyDefinition

public BooleanPropertyDefinition getAsynchronousPropertyDefinition()

Get the "asynchronous" property definition.

Indicates whether the File Based Debug Log Publisher will publish records asynchronously.

Returns:

Returns the "asynchronous" property definition.

getAutoFlushPropertyDefinition

public BooleanPropertyDefinition getAutoFlushPropertyDefinition()

Get the "auto-flush" property definition.

Specifies whether to flush the writer after every log record.

If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

Returns:

Returns the "auto-flush" property definition.

getBufferSizePropertyDefinition

public SizePropertyDefinition getBufferSizePropertyDefinition()

Get the "buffer-size" property definition.

Specifies the log file buffer size.

Returns:

Returns the "buffer-size" property 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 File Based 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 File Based Debug Log Publisher implementation.

Returns:

Returns the "java-class" property definition.

getLogFilePropertyDefinition

public StringPropertyDefinition getLogFilePropertyDefinition()

Get the "log-file" property definition.

The file name to use for the log files generated by the File Based Debug Log Publisher .

The path to the file is relative to the server root.

Returns:

Returns the "log-file" property definition.

getLogFilePermissionsPropertyDefinition

public StringPropertyDefinition getLogFilePermissionsPropertyDefinition()

Get the "log-file-permissions" property definition.

The UNIX permissions of the log files created by this File Based Debug Log Publisher .

Returns:

Returns the "log-file-permissions" property definition.

getQueueSizePropertyDefinition

public IntegerPropertyDefinition getQueueSizePropertyDefinition()

Get the "queue-size" property definition.

The maximum number of log records that can be stored in the asynchronous queue.

Returns:

Returns the "queue-size" property definition.

getRetentionPolicyPropertyDefinition

public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()

Get the "retention-policy" property definition.

The retention policy to use for the File Based Debug Log Publisher .

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Returns:

Returns the "retention-policy" property definition.

getRotationPolicyPropertyDefinition

public AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg> getRotationPolicyPropertyDefinition()

Get the "rotation-policy" property definition.

The rotation policy to use for the File Based Debug Log Publisher .

When multiple policies are used, rotation will occur if any policy's conditions are met.

Returns:

Returns the "rotation-policy" property definition.

getTimeIntervalPropertyDefinition

public DurationPropertyDefinition getTimeIntervalPropertyDefinition()

Get the "time-interval" property definition.

Specifies the interval at which to check whether the log files need to be rotated.

Returns:

Returns the "time-interval" property definition.

getDebugTargetsRelationDefinition

public InstantiableRelationDefinition<DebugTargetCfgClient,DebugTargetCfg> getDebugTargetsRelationDefinition()

Get the "debug-targets" relation definition.

Returns:

Returns the "debug-targets" relation definition.