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
@Deprecated
public class CsvAuditEventHandlerConfiguration
extends FileBasedEventHandlerConfiguration
Deprecated.
The tamper evident feature of the CSV handler is deprecated. In order to provide a migration path for
products, a second CSV handler has been created that does not include the tamper evident configuration. Located
under the forgerock-audit-handler-csv2 module, the new CsvAuditEventHandler uses the same package structure to avoid
major configuration changes.
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 classDeprecated.Contains the csv writer configuration parameters.static classDeprecated.Contains the configuration parameters to configure tamper evident logging.static classDeprecated.Configuration of event buffering.Nested classes/interfaces inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
FileBasedEventHandlerConfiguration.FileRetention, FileBasedEventHandlerConfiguration.FileRotation -
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.Event buffering is disabled by default. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Returns the configuration for events buffering.Deprecated.Returns the CSV formatting options.Deprecated.Returns the directory where CSV file is located.Deprecated.Returns the CSV tamper evident options.booleanDeprecated.States if anAuditEventHandlercan be used for queries.voidsetBufferingConfiguration(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingConfiguration) Deprecated.Sets the configuration for events buffering.voidDeprecated.Sets the CSV formatting options.voidsetLogDirectory(String directory) Deprecated.Sets the directory where CSV file is located.voidDeprecated.Sets 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 bufferingDeprecated.Event buffering is disabled by default.
-
-
Constructor Details
-
CsvAuditEventHandlerConfiguration
public CsvAuditEventHandlerConfiguration()Deprecated.
-
-
Method Details
-
getLogDirectory
Deprecated.Returns the directory where CSV file is located.- Returns:
- the location of the CSV file.
-
setLogDirectory
Deprecated.Sets the directory where CSV file is located.- Parameters:
directory- the directory.
-
getFormatting
Deprecated.Returns the CSV formatting options.- Returns:
- the CSV formatting options.
-
setFormatting
Deprecated.Sets the CSV formatting options.- Parameters:
formatting- the CSV formatting options to set.
-
getSecurity
Deprecated.Returns the CSV tamper evident options.- Returns:
- the CSV tamper evident options.
-
setSecurity
Deprecated.Sets the CSV tamper evident options.- Parameters:
security- the CSV tamper evident options to set.
-
getBuffering
Deprecated.Returns the configuration for events buffering.- Returns:
- the configuration
-
setBufferingConfiguration
public void setBufferingConfiguration(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration bufferingConfiguration) Deprecated.Sets the configuration for events buffering.- Parameters:
bufferingConfiguration- The configuration
-
isUsableForQueries
public boolean isUsableForQueries()Deprecated.Description copied from class:EventHandlerConfigurationStates if anAuditEventHandlercan be used for queries.- Specified by:
isUsableForQueriesin classEventHandlerConfiguration- Returns:
- True - If the
AuditEventHandlercan be used for queries. False - If theAuditEventHandlercan not be used for queries.
-