public interface FileBasedErrorLogPublisherCfg extends ErrorLogPublisherCfg
File Based Error Log Publishers publish error messages to the file system.
Modifier and Type | Method and Description |
---|---|
void |
addFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> listener)
Register to be notified when this File Based Error Log Publisher is changed.
|
Class<? extends FileBasedErrorLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this File Based Error Log Publisher.
|
long |
getBufferSize()
Gets the "buffer-size" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getLogFile()
Gets the "log-file" property.
|
String |
getLogFilePermissions()
Gets the "log-file-permissions" property.
|
int |
getQueueSize()
Gets the "queue-size" property.
|
SortedSet<String> |
getRetentionPolicy()
Gets the "retention-policy" property.
|
SortedSet<Dn> |
getRetentionPolicyDns()
Gets the "retention-policy" property as a set of DNs.
|
SortedSet<String> |
getRotationPolicy()
Gets the "rotation-policy" property.
|
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 |
removeFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> listener)
Deregister an existing File Based Error Log Publisher configuration change listener.
|
addErrorChangeListener, getDefaultSeverity, getOverrideSeverity, removeErrorChangeListener
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends FileBasedErrorLogPublisherCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface ErrorLogPublisherCfg
configurationClass
in interface LogPublisherCfg
void addFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> listener)
listener
- The File Based Error Log Publisher configuration change listener.void removeFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> listener)
listener
- The File Based Error Log Publisher configuration change listener.boolean isAppend()
Specifies whether to append to existing log files.
boolean isAsynchronous()
Indicates whether the File Based Error Log Publisher will publish records asynchronously.
boolean isAutoFlush()
Specifies whether to flush the writer after every log record.
If the asynchronous writes option is used, the writer will be flushed after all the log records in the queue are written.
long getBufferSize()
Specifies the log file buffer size.
String getJavaClass()
The fully-qualified name of the Java class that provides the File Based Error Log Publisher implementation.
getJavaClass
in interface ErrorLogPublisherCfg
getJavaClass
in interface LogPublisherCfg
String getLogFile()
The file name to use for the log files generated by the File Based Error Log Publisher .
The path to the file is relative to the server root.
String getLogFilePermissions()
The UNIX permissions of the log files created by this File Based Error Log Publisher .
int getQueueSize()
The maximum number of log records that can be stored in the asynchronous queue.
SortedSet<String> getRetentionPolicy()
The retention policy to use for the File Based Error Log Publisher .
When multiple policies are used, log files will be cleaned when any of the policy's conditions are met.
SortedSet<Dn> getRetentionPolicyDns()
The retention policy to use for the File Based Error Log Publisher .
When multiple policies are used, log files will be cleaned when any of the policy's conditions are met.
SortedSet<String> getRotationPolicy()
The rotation policy to use for the File Based Error Log Publisher .
When multiple policies are used, rotation will occur if any policy's conditions are met.
SortedSet<Dn> getRotationPolicyDns()
The rotation policy to use for the File Based Error Log Publisher .
When multiple policies are used, rotation will occur if any policy's conditions are met.
long getTimeInterval()
Specifies the interval at which to check whether the log files need to be rotated.
Copyright 2010-2020 ForgeRock AS.