public interface FileBasedHTTPAccessLogPublisherCfg extends HTTPAccessLogPublisherCfg
File Based HTTP Access Log Publishers publish HTTP access messages to the file system.
Modifier and Type | Method and Description |
---|---|
void |
addFileBasedHTTPAccessChangeListener(ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg> listener)
Register to be notified when this File Based HTTP Access Log Publisher is changed.
|
Class<? extends FileBasedHTTPAccessLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this File Based HTTP 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.
|
String |
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.
|
void |
removeFileBasedHTTPAccessChangeListener(ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg> listener)
Deregister an existing File Based HTTP Access Log Publisher configuration change listener.
|
addHTTPAccessChangeListener, removeHTTPAccessChangeListener
addChangeListener, isEnabled, removeChangeListener
dn
Class<? extends FileBasedHTTPAccessLogPublisherCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface HTTPAccessLogPublisherCfg
configurationClass
in interface LogPublisherCfg
void addFileBasedHTTPAccessChangeListener(ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg> listener)
listener
- The File Based HTTP Access Log Publisher configuration change listener.void removeFileBasedHTTPAccessChangeListener(ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg> listener)
listener
- The File Based HTTP Access Log Publisher configuration change listener.boolean isAppend()
Specifies whether to append to existing log files.
boolean isAsynchronous()
Indicates whether the File Based HTTP 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 HTTP Access Log Publisher implementation.
getJavaClass
in interface HTTPAccessLogPublisherCfg
getJavaClass
in interface LogPublisherCfg
String getLogFile()
The file name to use for the log files generated by the File Based HTTP 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 HTTP Access Log Publisher.
String getLogFormat()
Specifies how log records should be formatted and written to the HTTP 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 HTTP 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 HTTP 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 HTTP 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 HTTP 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-2017 ForgeRock AS.