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
Nested ClassesModifier and TypeClassDescriptionstatic classContains the csv writer configuration parameters.static classContains the configuration parameters to configure tamper evident logging.static classConfiguration of event buffering.Nested classes/interfaces inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
FileBasedEventHandlerConfiguration.FileRetention, FileBasedEventHandlerConfiguration.FileRotation -
Field Summary
FieldsModifier and TypeFieldDescriptionEvent buffering is disabled by default. -
Constructor Summary
Constructors -
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.booleanvoidsetBufferingConfiguration(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingConfiguration) Sets the configuration for events buffering.voidSets the CSV formatting options.voidsetLogDirectory(String directory) Sets the directory where CSV file is located.voidSets the CSV tamper evident options.Methods inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
getFileRetention, getFileRotation, getRotationRetentionCheckInterval, setFileRetention, setFileRotation, setRotationRetentionCheckIntervalMethods 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
- Specified by:
isUsableForQueriesin classEventHandlerConfiguration
-