Package org.forgerock.audit.handlers.csv
Class CsvAuditEventHandlerConfiguration
java.lang.Object
org.forgerock.audit.events.handlers.EventHandlerConfiguration
org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
A configuration for CSV audit event handler.
This configuration object can be created from JSON. Example of valid JSON configuration:
{ "name" : "csv", "topics": [ "access", "activity", "config", "authentication" ], "logDirectory" : "/path/to/audit/files/", "formatting" : { "quoteChar" : "\"", "delimiterChar" : ",", "endOfLineSymbols" : "\n" }, "security" : { "enabled" : "true", "filename" : "/path/to/keystore.jks", "password" : "correcthorsebatterystaple", "signatureInterval" : "3 seconds" }, "buffering" : { "enabled" : "true", "autoFlush" : "true" } }
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Contains the csv writer configuration parameters.static class
Contains the configuration parameters to configure tamper evident logging.static class
Configuration of event buffering.Nested classes/interfaces inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
FileBasedEventHandlerConfiguration.FileRetention, FileBasedEventHandlerConfiguration.FileRotation
-
Field Summary
Modifier and TypeFieldDescriptionEvent buffering is disabled by default. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the configuration for events buffering.Returns the CSV formatting options.Returns the directory where CSV file is located.Returns the CSV tamper evident options.boolean
States if anAuditEventHandler
can be used for queries.void
setBufferingConfiguration
(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingConfiguration) Sets the configuration for events buffering.void
Sets the CSV formatting options.void
setLogDirectory
(String directory) Sets the directory where CSV file is located.void
Sets the CSV tamper evident options.Methods inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
getFileRetention, getFileRotation, getRotationRetentionCheckInterval, setFileRetention, setFileRotation, setRotationRetentionCheckInterval
Methods inherited from class org.forgerock.audit.events.handlers.EventHandlerConfiguration
getName, getTopics, isEnabled, setEnabled, setName, setTopics
-
Field Details
-
buffering
@JsonPropertyDescription("audit.handlers.csv.buffering") protected CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingEvent buffering is disabled by default.
-
-
Constructor Details
-
CsvAuditEventHandlerConfiguration
public CsvAuditEventHandlerConfiguration()
-
-
Method Details
-
getLogDirectory
Returns the directory where CSV file is located.- Returns:
- the location of the CSV file.
-
setLogDirectory
Sets the directory where CSV file is located.- Parameters:
directory
- the directory.
-
getFormatting
Returns the CSV formatting options.- Returns:
- the CSV formatting options.
-
setFormatting
Sets the CSV formatting options.- Parameters:
formatting
- the CSV formatting options to set.
-
getSecurity
Returns the CSV tamper evident options.- Returns:
- the CSV tamper evident options.
-
setSecurity
Sets the CSV tamper evident options.- Parameters:
security
- the CSV tamper evident options to set.
-
getBuffering
Returns the configuration for events buffering.- Returns:
- the configuration
-
setBufferingConfiguration
public void setBufferingConfiguration(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingConfiguration) Sets the configuration for events buffering.- Parameters:
bufferingConfiguration
- The configuration
-
isUsableForQueries
public boolean isUsableForQueries()Description copied from class:EventHandlerConfiguration
States if anAuditEventHandler
can be used for queries.- Specified by:
isUsableForQueries
in classEventHandlerConfiguration
- Returns:
- True - If the
AuditEventHandler
can be used for queries. False - If theAuditEventHandler
can not be used for queries.
-