public interface CsvFileHttpAccessLogPublisherCfg extends HttpAccessLogPublisherCfg
CSV File HTTP Access Log Publishers publish HTTP access messages to CSV files.
Modifier and Type | Method and Description |
---|---|
void |
addCsvFileHttpAccessChangeListener(ConfigurationChangeListener<CsvFileHttpAccessLogPublisherCfg> listener)
Register to be notified when this CSV File HTTP Access Log Publisher is changed.
|
Class<? extends CsvFileHttpAccessLogPublisherCfg> |
configurationClass()
Gets the configuration class associated with this CSV File HTTP Access Log Publisher.
|
String |
getCsvDelimiterChar()
Gets the "csv-delimiter-char" property.
|
String |
getCsvEolSymbols()
Gets the "csv-eol-symbols" property.
|
String |
getCsvQuoteChar()
Gets the "csv-quote-char" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getKeyStoreFile()
Gets the "key-store-file" property.
|
String |
getKeyStorePin()
Gets the "key-store-pin" property.
|
String |
getLogDirectory()
Gets the "log-directory" 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 |
getSignatureTimeInterval()
Gets the "signature-time-interval" property.
|
boolean |
isAsynchronous()
Gets the "asynchronous" property.
|
boolean |
isAutoFlush()
Gets the "auto-flush" property.
|
boolean |
isTamperEvident()
Gets the "tamper-evident" property.
|
void |
removeCsvFileHttpAccessChangeListener(ConfigurationChangeListener<CsvFileHttpAccessLogPublisherCfg> listener)
Deregister an existing CSV File HTTP Access Log Publisher configuration change listener.
|
addHttpAccessChangeListener, removeHttpAccessChangeListener
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends CsvFileHttpAccessLogPublisherCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface HttpAccessLogPublisherCfg
configurationClass
in interface LogPublisherCfg
void addCsvFileHttpAccessChangeListener(ConfigurationChangeListener<CsvFileHttpAccessLogPublisherCfg> listener)
listener
- The CSV File HTTP Access Log Publisher configuration change listener.void removeCsvFileHttpAccessChangeListener(ConfigurationChangeListener<CsvFileHttpAccessLogPublisherCfg> listener)
listener
- The CSV File HTTP Access Log Publisher configuration change listener.boolean isAsynchronous()
Indicates whether the CSV File 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.
String getCsvDelimiterChar()
The delimiter character to use when writing in CSV format.
String getCsvEolSymbols()
The string that marks the end of a line.
String getCsvQuoteChar()
The character to append and prepend to a CSV field when writing in CSV format.
String getJavaClass()
The fully-qualified name of the Java class that provides the CSV File HTTP Access Log Publisher implementation.
getJavaClass
in interface HttpAccessLogPublisherCfg
getJavaClass
in interface LogPublisherCfg
String getKeyStoreFile()
Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.
Changes to this property will take effect the next time that the key store is accessed.
String getKeyStorePin()
Specifies the clear-text PIN needed to access the CSV File HTTP Access Log Publisher .
String getLogDirectory()
The directory to use for the log files generated by the CSV File HTTP Access Log Publisher. The path to the directory is relative to the server root.
SortedSet<String> getRetentionPolicy()
The retention policy to use for the CSV File 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 CSV File 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 CSV File 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 CSV File HTTP Access Log Publisher .
When multiple policies are used, rotation will occur if any policy's conditions are met.
long getSignatureTimeInterval()
Specifies the interval at which to sign the log file when secure option is enabled.
boolean isTamperEvident()
Specifies whether the log should be signed in order to detect tampering.
Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significative impact on performance of the server.
Copyright 2010-2018 ForgeRock AS.