public final class FileBasedDebugLogPublisherCfgDefn extends ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>
File Based Debug Log Publishers publish debug messages to the file system.
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
public static FileBasedDebugLogPublisherCfgDefn getInstance()
public FileBasedDebugLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends FileBasedDebugLogPublisherCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>
impl
- The managed object.public FileBasedDebugLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends FileBasedDebugLogPublisherCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>
impl
- The server managed object.public Class<FileBasedDebugLogPublisherCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<FileBasedDebugLogPublisherCfgClient,FileBasedDebugLogPublisherCfg>
public BooleanPropertyDefinition getAppendPropertyDefinition()
Specifies whether to append to existing log files.
public BooleanPropertyDefinition getAsynchronousPropertyDefinition()
Indicates whether the File Based Debug Log Publisher will publish records asynchronously.
public BooleanPropertyDefinition getAutoFlushPropertyDefinition()
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.
public SizePropertyDefinition getBufferSizePropertyDefinition()
Specifies the log file buffer size.
public BooleanPropertyDefinition getDefaultDebugExceptionsOnlyPropertyDefinition()
Indicates whether only logs with exception should be logged.
public BooleanPropertyDefinition getDefaultIncludeThrowableCausePropertyDefinition()
Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
public BooleanPropertyDefinition getDefaultOmitMethodEntryArgumentsPropertyDefinition()
Indicates whether to include method arguments in debug messages logged by default.
public BooleanPropertyDefinition getDefaultOmitMethodReturnValuePropertyDefinition()
Indicates whether to include the return value in debug messages logged by default.
public IntegerPropertyDefinition getDefaultThrowableStackFramesPropertyDefinition()
Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the File Based Debug Log Publisher is enabled for use.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
The fully-qualified name of the Java class that provides the File Based Debug Log Publisher implementation.
public StringPropertyDefinition getLogFilePropertyDefinition()
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.
public StringPropertyDefinition getLogFilePermissionsPropertyDefinition()
The UNIX permissions of the log files created by this File Based Debug Log Publisher .
public IntegerPropertyDefinition getQueueSizePropertyDefinition()
The maximum number of log records that can be stored in the asynchronous queue.
public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()
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.
public AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg> getRotationPolicyPropertyDefinition()
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.
public DurationPropertyDefinition getTimeIntervalPropertyDefinition()
Specifies the interval at which to check whether the log files need to be rotated.
public InstantiableRelationDefinition<DebugTargetCfgClient,DebugTargetCfg> getDebugTargetsRelationDefinition()
Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.