org.opends.server.admin.std.server
Interface FileBasedDebugLogPublisherCfg

All Superinterfaces:
Configuration, DebugLogPublisherCfg, LogPublisherCfg

public interface FileBasedDebugLogPublisherCfg
extends DebugLogPublisherCfg

A server-side interface for querying File Based Debug Log Publisher settings.

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


Method Summary
 void addFileBasedDebugChangeListener(ConfigurationChangeListener<FileBasedDebugLogPublisherCfg> listener)
          Register to be notified when this File Based Debug Log Publisher is changed.
 java.lang.Class<? extends FileBasedDebugLogPublisherCfg> configurationClass()
          Gets the configuration class associated with this File Based Debug Log Publisher.
 long getBufferSize()
          Gets the "buffer-size" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getLogFile()
          Gets the "log-file" property.
 java.lang.String getLogFilePermissions()
          Gets the "log-file-permissions" property.
 int getQueueSize()
          Gets the "queue-size" property.
 java.util.SortedSet<java.lang.String> getRetentionPolicy()
          Gets the "retention-policy" property.
 java.util.SortedSet<DN> getRetentionPolicyDNs()
          Gets the "retention-policy" property as a set of DNs.
 java.util.SortedSet<java.lang.String> getRotationPolicy()
          Gets the "rotation-policy" property.
 java.util.SortedSet<DN> getRotationPolicyDNs()
          Gets the "rotation-policy" property as a set of DNs.
 long getTimeInterval()
          Gets the "time-interval" property.
 boolean isAppend()
          Gets the "append" property.
 boolean isAsynchronous()
          Gets the "asynchronous" property.
 boolean isAutoFlush()
          Gets the "auto-flush" property.
 void removeFileBasedDebugChangeListener(ConfigurationChangeListener<FileBasedDebugLogPublisherCfg> listener)
          Deregister an existing File Based Debug Log Publisher configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.DebugLogPublisherCfg
addDebugChangeListener, addDebugTargetAddListener, addDebugTargetDeleteListener, getDebugTarget, getDefaultDebugCategory, getDefaultDebugLevel, getDefaultThrowableStackFrames, isDefaultIncludeThrowableCause, isDefaultOmitMethodEntryArguments, isDefaultOmitMethodReturnValue, listDebugTargets, removeDebugChangeListener, removeDebugTargetAddListener, removeDebugTargetDeleteListener
 
Methods inherited from interface org.opends.server.admin.std.server.LogPublisherCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends FileBasedDebugLogPublisherCfg> configurationClass()
Gets the configuration class associated with this File Based Debug Log Publisher.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface DebugLogPublisherCfg
Specified by:
configurationClass in interface LogPublisherCfg
Returns:
Returns the configuration class associated with this File Based Debug Log Publisher.

addFileBasedDebugChangeListener

void addFileBasedDebugChangeListener(ConfigurationChangeListener<FileBasedDebugLogPublisherCfg> listener)
Register to be notified when this File Based Debug Log Publisher is changed.

Parameters:
listener - The File Based Debug Log Publisher configuration change listener.

removeFileBasedDebugChangeListener

void removeFileBasedDebugChangeListener(ConfigurationChangeListener<FileBasedDebugLogPublisherCfg> listener)
Deregister an existing File Based Debug Log Publisher configuration change listener.

Parameters:
listener - The File Based Debug Log Publisher configuration change listener.

isAppend

boolean isAppend()
Gets the "append" property.

Specifies whether to append to existing log files.

Returns:
Returns the value of the "append" property.

isAsynchronous

boolean isAsynchronous()
Gets the "asynchronous" property.

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

Returns:
Returns the value of the "asynchronous" property.

isAutoFlush

boolean isAutoFlush()
Gets the "auto-flush" property.

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 value of the "auto-flush" property.

getBufferSize

long getBufferSize()
Gets the "buffer-size" property.

Specifies the log file buffer size.

Returns:
Returns the value of the "buffer-size" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface DebugLogPublisherCfg
Returns:
Returns the value of the "java-class" property.

getLogFile

java.lang.String getLogFile()
Gets the "log-file" property.

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 value of the "log-file" property.

getLogFilePermissions

java.lang.String getLogFilePermissions()
Gets the "log-file-permissions" property.

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

Returns:
Returns the value of the "log-file-permissions" property.

getQueueSize

int getQueueSize()
Gets the "queue-size" property.

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

Returns:
Returns the value of the "queue-size" property.

getRetentionPolicy

java.util.SortedSet<java.lang.String> getRetentionPolicy()
Gets the "retention-policy" property.

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 an unmodifiable set containing the values of the "retention-policy" property.

getRetentionPolicyDNs

java.util.SortedSet<DN> getRetentionPolicyDNs()
Gets the "retention-policy" property as a set of DNs.

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 DN values of the "retention-policy" property.

getRotationPolicy

java.util.SortedSet<java.lang.String> getRotationPolicy()
Gets the "rotation-policy" property.

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 an unmodifiable set containing the values of the "rotation-policy" property.

getRotationPolicyDNs

java.util.SortedSet<DN> getRotationPolicyDNs()
Gets the "rotation-policy" property as a set of DNs.

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 DN values of the "rotation-policy" property.

getTimeInterval

long getTimeInterval()
Gets the "time-interval" property.

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

Returns:
Returns the value of the "time-interval" property.