public interface FileBasedAccessLogPublisherCfg extends AccessLogPublisherCfg
File Based Access Log Publishers publish access messages to the file system.
Modifier and Type | Method and Description |
---|---|
void |
addFileBasedAccessChangeListener(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
Register to be notified when this File Based Access Log Publisher is changed.
|
Class<? extends FileBasedAccessLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this File Based Access 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.
|
FileBasedAccessLogPublisherCfgDefn.LogFormat |
getLogFormat()
Gets the "log-format" property.
|
String |
getLogRecordTimeFormat()
Gets the "log-record-time-format" 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.
|
boolean |
isLogControlOids()
Gets the "log-control-oids" property.
|
void |
removeFileBasedAccessChangeListener(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
Deregister an existing File Based Access Log Publisher configuration change listener.
|
addAccessChangeListener, addAccessLogFilteringCriteriaAddListener, addAccessLogFilteringCriteriaDeleteListener, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessChangeListener, removeAccessLogFilteringCriteriaAddListener, removeAccessLogFilteringCriteriaDeleteListener
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends FileBasedAccessLogPublisherCfg> configurationClass()
configurationClass
in interface AccessLogPublisherCfg
configurationClass
in interface Configuration
configurationClass
in interface LogPublisherCfg
void addFileBasedAccessChangeListener(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
listener
- The File Based Access Log Publisher configuration change listener.void removeFileBasedAccessChangeListener(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
listener
- The File Based Access Log Publisher configuration change listener.boolean isAppend()
Specifies whether to append to existing log files.
boolean isAsynchronous()
Indicates whether the File Based Access 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 is 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 Access Log Publisher implementation.
getJavaClass
in interface AccessLogPublisherCfg
getJavaClass
in interface LogPublisherCfg
boolean isLogControlOids()
Specifies whether control OIDs will be included in operation log records.
String getLogFile()
The file name to use for the log files generated by the File Based Access 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 Access Log Publisher.
FileBasedAccessLogPublisherCfgDefn.LogFormat getLogFormat()
Specifies how log records should be formatted and written to the access log.
String getLogRecordTimeFormat()
Specifies the format string that is used to generate log record timestamps.
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 Access Log Publisher .
When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
SortedSet<Dn> getRetentionPolicyDns()
The retention policy to use for the File Based Access Log Publisher .
When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
SortedSet<String> getRotationPolicy()
The rotation policy to use for the File Based Access 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 Access 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-2018 ForgeRock AS.