Interface CsvFileAccessLogPublisherCfg
-
- All Superinterfaces:
AccessLogPublisherCfg
,CommonAuditAccessLogPublisherCfg
,Configuration
,LogPublisherCfg
public interface CsvFileAccessLogPublisherCfg extends CommonAuditAccessLogPublisherCfg
A server-side interface for querying CSV File Access Log Publisher settings.CSV File Access Log Publishers publish access messages to CSV files.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)
Register to be notified when this CSV File Access Log Publisher is changed.Class<? extends CsvFileAccessLogPublisherCfg>
configurationClass()
Gets the configuration class associated with this CSV File 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>
getLogFieldBlacklist()
Gets the "log-field-blacklist" property.String
getLogFileNamePrefix()
Gets the "log-file-name-prefix" 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
removeCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)
Deregister an existing CSV File Access Log Publisher configuration change listener.-
Methods inherited from interface org.forgerock.opendj.server.config.server.AccessLogPublisherCfg
addAccessChangeListener, addAccessLogFilteringCriteriaAddListener, addAccessLogFilteringCriteriaDeleteListener, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessChangeListener, removeAccessLogFilteringCriteriaAddListener, removeAccessLogFilteringCriteriaDeleteListener
-
Methods inherited from interface org.forgerock.opendj.server.config.server.CommonAuditAccessLogPublisherCfg
addCommonAuditAccessChangeListener, isLogControlOids, removeCommonAuditAccessChangeListener
-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.LogPublisherCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends CsvFileAccessLogPublisherCfg> configurationClass()
Gets the configuration class associated with this CSV File Access Log Publisher.- Specified by:
configurationClass
in interfaceAccessLogPublisherCfg
- Specified by:
configurationClass
in interfaceCommonAuditAccessLogPublisherCfg
- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceLogPublisherCfg
- Returns:
- Returns the configuration class associated with this CSV File Access Log Publisher.
-
addCsvFileAccessChangeListener
void addCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)
Register to be notified when this CSV File Access Log Publisher is changed.- Parameters:
listener
- The CSV File Access Log Publisher configuration change listener.
-
removeCsvFileAccessChangeListener
void removeCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)
Deregister an existing CSV File Access Log Publisher configuration change listener.- Parameters:
listener
- The CSV File Access Log Publisher configuration change listener.
-
isAsynchronous
boolean isAsynchronous()
Gets the "asynchronous" property.Indicates whether the CSV File Access Log Publisher will publish records asynchronously.
Default value:
true
- 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.
Default value:
true
- Returns:
- Returns the value of the "auto-flush" property.
-
getCsvDelimiterChar
String getCsvDelimiterChar()
Gets the "csv-delimiter-char" property.The delimiter character to use when writing in CSV format.
Default value:
,
- Returns:
- Returns the value of the "csv-delimiter-char" property.
-
getCsvEolSymbols
String getCsvEolSymbols()
Gets the "csv-eol-symbols" property.The string that marks the end of a line.
- Returns:
- Returns the value of the "csv-eol-symbols" property.
-
getCsvQuoteChar
String getCsvQuoteChar()
Gets the "csv-quote-char" property.The character to append and prepend to a CSV field when writing in CSV format.
Default value:
\"
- Returns:
- Returns the value of the "csv-quote-char" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.The fully-qualified name of the Java class that provides the CSV File Access Log Publisher implementation.
Default value:
org.opends.server.loggers.CsvFileAccessLogPublisher
- Specified by:
getJavaClass
in interfaceAccessLogPublisherCfg
- Specified by:
getJavaClass
in interfaceLogPublisherCfg
- Returns:
- Returns the value of the "java-class" property.
-
getKeyStoreFile
String getKeyStoreFile()
Gets the "key-store-file" property.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.
Default value is undefined
- Returns:
- Returns the value of the "key-store-file" property.
-
getKeyStorePin
String getKeyStorePin()
Gets the "key-store-pin" property.Specifies the clear-text PIN needed to access the CSV File Access Log Publisher .
Default value is undefined
- Returns:
- Returns the value of the "key-store-pin" property.
-
getLogDirectory
String getLogDirectory()
Gets the "log-directory" property.The directory to use for the log files generated by the CSV File Access Log Publisher. The path to the directory is relative to the server root.
Default value:
logs
- Returns:
- Returns the value of the "log-directory" property.
-
getLogFieldBlacklist
SortedSet<String> getLogFieldBlacklist()
Gets the "log-field-blacklist" property.List of fields that the server omits from access log messages.
Valid values for this property are JSON paths for fields present in the log file.
- Returns:
- Returns an unmodifiable set containing the values of the "log-field-blacklist" property.
-
getLogFileNamePrefix
String getLogFileNamePrefix()
Gets the "log-file-name-prefix" property.File name prefix (without extension) for CSV and JSON file based access log publishers.
Default value:
ldap-access
- Returns:
- Returns the value of the "log-file-name-prefix" property.
-
getRetentionPolicy
SortedSet<String> getRetentionPolicy()
Gets the "retention-policy" property.The retention policy to use for the CSV File Access 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
SortedSet<Dn> getRetentionPolicyDns()
Gets the "retention-policy" property as a set of DNs.The retention policy to use for the CSV File Access 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
SortedSet<String> getRotationPolicy()
Gets the "rotation-policy" property.The rotation policy to use for the CSV File Access 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
SortedSet<Dn> getRotationPolicyDns()
Gets the "rotation-policy" property as a set of DNs.The rotation policy to use for the CSV File Access 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.
-
getSignatureTimeInterval
long getSignatureTimeInterval()
Gets the "signature-time-interval" property.Specifies the interval at which to sign the log file when the tamper-evident option is enabled.
Default value:
3s
- Returns:
- Returns the value of the "signature-time-interval" property.
-
isTamperEvident
boolean isTamperEvident()
Gets the "tamper-evident" property.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.
Default value:
false
- Returns:
- Returns the value of the "tamper-evident" property.
-
-