Package org.forgerock.audit.handlers.splunk

Class SplunkAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler

All Implemented Interfaces:

AuditEventHandler, BatchConsumer

public final class SplunkAuditEventHandler
extends AuditEventHandlerBase
implements BatchConsumer

Audit event handler that writes out to Splunk's HTTP event collector RAW endpoint.

Field Summary

Fields inherited from class org.forgerock.audit.events.handlers.AuditEventHandlerBase

eventTopicsMetaData

Constructor Summary

Constructors

Constructor	Description
SplunkAuditEventHandler(SplunkAuditEventHandlerConfiguration configuration, EventTopicsMetaData eventTopicsMetaData, BatchPublisherFactory publisherFactory, org.forgerock.http.Client client)	Constructs a new Splunk audit event handler.

Method Summary

Modifier and Type	Method	Description
void	addToBatch(String topic, org.forgerock.json.JsonValue event, StringBuilder payload)
org.forgerock.util.promise.Promise<Void,BatchException>	publishBatch(String payload)
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	publishEvent(org.forgerock.services.context.Context context, String topic, org.forgerock.json.JsonValue event)
org.forgerock.util.promise.Promise<QueryResponse,ResourceException>	queryEvents(org.forgerock.services.context.Context context, String topic, QueryRequest query, QueryResourceHandler handler)
org.forgerock.util.promise.Promise<ResourceResponse,ResourceException>	readEvent(org.forgerock.services.context.Context context, String topic, String resourceId)
void	shutdown()
void	startup()

Methods inherited from class org.forgerock.audit.events.handlers.AuditEventHandlerBase

getHandledTopics, getName, handleAction, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

SplunkAuditEventHandler

public SplunkAuditEventHandler(SplunkAuditEventHandlerConfiguration configuration,
 EventTopicsMetaData eventTopicsMetaData,
 BatchPublisherFactory publisherFactory,
 org.forgerock.http.Client client)

Constructs a new Splunk audit event handler.

Parameters:

configuration - the Splunk audit event handler configuration

eventTopicsMetaData - topic meta data

publisherFactory - the batch publisher factory or null

client - HTTP client or null

Method Details

startup

public void startup()
             throws ResourceException

Specified by:

startup in interface AuditEventHandler

Throws:

ResourceException

shutdown

public void shutdown()
              throws ResourceException

Specified by:

shutdown in interface AuditEventHandler

Throws:

ResourceException

publishEvent

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> publishEvent(org.forgerock.services.context.Context context,
 String topic,
 org.forgerock.json.JsonValue event)

Specified by:

publishEvent in interface AuditEventHandler

readEvent

public org.forgerock.util.promise.Promise<ResourceResponse,ResourceException> readEvent(org.forgerock.services.context.Context context,
 String topic,
 String resourceId)

Specified by:

readEvent in interface AuditEventHandler

queryEvents

public org.forgerock.util.promise.Promise<QueryResponse,ResourceException> queryEvents(org.forgerock.services.context.Context context,
 String topic,
 QueryRequest query,
 QueryResourceHandler handler)

Specified by:

queryEvents in interface AuditEventHandler

addToBatch

public void addToBatch(String topic,
 org.forgerock.json.JsonValue event,
 StringBuilder payload)
                throws BatchException

Specified by:

addToBatch in interface BatchConsumer

Throws:

BatchException

publishBatch

public org.forgerock.util.promise.Promise<Void,BatchException> publishBatch(String payload)

Specified by:

publishBatch in interface BatchConsumer