Package org.forgerock.audit.handlers.json

Class JsonAuditEventHandlerConfiguration

java.lang.Object

org.forgerock.audit.events.handlers.EventHandlerConfiguration

org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration

org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration

public class JsonAuditEventHandlerConfiguration
extends FileBasedEventHandlerConfiguration

Configuration for JsonAuditEventHandler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonAuditEventHandlerConfiguration.EventBufferingConfiguration	Configuration of event buffering.

Nested classes/interfaces inherited from class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration

FileBasedEventHandlerConfiguration.FileRetention, FileBasedEventHandlerConfiguration.FileRotation

Constructor Summary

Constructors

Constructor	Description
JsonAuditEventHandlerConfiguration()

Method Summary

Modifier and Type	Method	Description
JsonAuditEventHandlerConfiguration.EventBufferingConfiguration	getBuffering()	Gets configuration of event buffering.
String	getLogDirectory()	Gets the directory where the JSON file is located.
boolean	isElasticsearchCompatible()	Determines if JSON format should be transformed to be compatible with ElasticSearch format restrictions.
boolean	isUsableForQueries()	States if an AuditEventHandler can be used for queries.
void	setBuffering(JsonAuditEventHandlerConfiguration.EventBufferingConfiguration buffering)	Sets configuration of event buffering.
void	setElasticsearchCompatible(boolean elasticsearchCompatible)	Specifies if JSON format should be transformed to be compatible with ElasticSearch format restrictions.
void	setLogDirectory(String directory)	Sets the directory where the JSON file is located.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JsonAuditEventHandlerConfiguration

public JsonAuditEventHandlerConfiguration()

Method Details

getLogDirectory

public String getLogDirectory()

Gets the directory where the JSON file is located.

Returns:

location of the JSON file

setLogDirectory

public void setLogDirectory(String directory)

Sets the directory where the JSON file is located.

Parameters:

directory - location of the JSON file

isElasticsearchCompatible

public boolean isElasticsearchCompatible()

Determines if JSON format should be transformed to be compatible with ElasticSearch format restrictions.

Returns:

true for ElasticSearch JSON format compatibility enforcement and false otherwise

setElasticsearchCompatible

public void setElasticsearchCompatible(boolean elasticsearchCompatible)

Specifies if JSON format should be transformed to be compatible with ElasticSearch format restrictions.

Parameters:

elasticsearchCompatible - true for ElasticSearch JSON format compatibility enforcements and false otherwise

getBuffering

public JsonAuditEventHandlerConfiguration.EventBufferingConfiguration getBuffering()

Gets configuration of event buffering.

Returns:

configuration of event buffering

setBuffering

public void setBuffering(JsonAuditEventHandlerConfiguration.EventBufferingConfiguration buffering)

Sets configuration of event buffering.

Parameters:

buffering - configuration of event buffering

isUsableForQueries

public boolean isUsableForQueries()

Description copied from class: EventHandlerConfiguration

States if an AuditEventHandler can be used for queries.

Specified by:

isUsableForQueries in class EventHandlerConfiguration

Returns:

True - If the AuditEventHandler can be used for queries. False - If the AuditEventHandler can not be used for queries.