Class ElasticsearchAuditEventHandlerConfiguration
- java.lang.Object
-
- org.forgerock.audit.events.handlers.EventHandlerConfiguration
-
- org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration
-
public class ElasticsearchAuditEventHandlerConfiguration extends EventHandlerConfiguration
A configuration for Elasticsearch audit event handler.This configuration object can be created from JSON. Example of valid JSON configuration:
{ "name" : "elasticsearch", "topics": [ "access", "activity", "config", "authentication" ], "connection" : { "useSSL" : true, "host" : "localhost", "port" : 9200, "username" : "myUsername", "password" : "myPassword" }, "indexMapping" : { "indexName" : "audit" }, "buffering" : { "enabled" : true, "maxSize" : 10000, "writeInterval" : "250 millis", "maxBatchedEvents" : 500 } }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classElasticsearchAuditEventHandlerConfiguration.ConnectionConfigurationConfiguration of connection to Elasticsearch.static classElasticsearchAuditEventHandlerConfiguration.EventBufferingConfigurationConfiguration of event buffering.static classElasticsearchAuditEventHandlerConfiguration.IndexMappingConfigurationConfiguration of index mapping.
-
Constructor Summary
Constructors Constructor Description ElasticsearchAuditEventHandlerConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfigurationgetBuffering()Gets configuration of event buffering.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfigurationgetConnection()Gets configuration of connection to Elasticsearch.ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfigurationgetIndexMapping()Sets configuration of index mapping.booleanisUsableForQueries()States if anAuditEventHandlercan be used for queries.voidsetBuffering(ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration buffering)Sets configuration of event buffering.voidsetConnection(ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration connection)Sets configuration of connection to Elasticsearch.voidsetIndexMapping(ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration indexMapping)Gets configuration of index mapping.-
Methods inherited from class org.forgerock.audit.events.handlers.EventHandlerConfiguration
getName, getTopics, isEnabled, setEnabled, setName, setTopics
-
-
-
-
Method Detail
-
getConnection
public ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration getConnection()
Gets configuration of connection to Elasticsearch.- Returns:
- configuration of connection to Elasticsearch
-
setConnection
public void setConnection(ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration connection)
Sets configuration of connection to Elasticsearch.- Parameters:
connection- configuration of connection to Elasticsearch
-
getIndexMapping
public ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration getIndexMapping()
Sets configuration of index mapping.- Returns:
- configuration of index mapping
-
setIndexMapping
public void setIndexMapping(ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration indexMapping)
Gets configuration of index mapping.- Parameters:
indexMapping- configuration of index mapping
-
getBuffering
public ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration getBuffering()
Gets configuration of event buffering.- Returns:
- configuration of event buffering
-
setBuffering
public void setBuffering(ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration buffering)
Sets configuration of event buffering.- Parameters:
buffering- configuration of event buffering
-
isUsableForQueries
public boolean isUsableForQueries()
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.
-
-