Package org.forgerock.audit.handlers.splunk

Class SplunkAuditEventHandlerConfiguration

java.lang.Object

org.forgerock.audit.events.handlers.EventHandlerConfiguration

org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration

public final class SplunkAuditEventHandlerConfiguration
extends EventHandlerConfiguration

Configuration for the splunk audit event handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SplunkAuditEventHandlerConfiguration.BufferingConfiguration	Configuration of event buffering.
static final class	SplunkAuditEventHandlerConfiguration.ConnectionConfiguration	Configuration of connection to Splunk.

Constructor Summary

Constructors

Constructor	Description
SplunkAuditEventHandlerConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getAuthzToken()	Gets the Splunk authorization token required for making HTTP event collector calls.
SplunkAuditEventHandlerConfiguration.BufferingConfiguration	getBuffering()	Gets the configuration for buffering.
SplunkAuditEventHandlerConfiguration.ConnectionConfiguration	getConnection()	Gets configuration of connection to Splunk.
boolean	isUsableForQueries()	States if an AuditEventHandler can be used for queries.
void	setAuthzToken(String authzToken)	Sets the Splunk authorization token required for making HTTP event collector calls.
void	setBuffering(SplunkAuditEventHandlerConfiguration.BufferingConfiguration buffering)	Sets the configuration for buffering.
void	setConnection(SplunkAuditEventHandlerConfiguration.ConnectionConfiguration connection)	Sets configuration of connection to Splunk.

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

SplunkAuditEventHandlerConfiguration

public SplunkAuditEventHandlerConfiguration()

Method Details

getBuffering

public SplunkAuditEventHandlerConfiguration.BufferingConfiguration getBuffering()

Gets the configuration for buffering.

Returns:

the buffering configuration

setBuffering

public void setBuffering(SplunkAuditEventHandlerConfiguration.BufferingConfiguration buffering)

Sets the configuration for buffering.

Parameters:

buffering - the buffering configuration

getConnection

public SplunkAuditEventHandlerConfiguration.ConnectionConfiguration getConnection()

Gets configuration of connection to Splunk.

Returns:

configuration of connection to Splunk

setConnection

public void setConnection(SplunkAuditEventHandlerConfiguration.ConnectionConfiguration connection)

Sets configuration of connection to Splunk.

Parameters:

connection - configuration of connection to Splunk

getAuthzToken

public String getAuthzToken()

Gets the Splunk authorization token required for making HTTP event collector calls.

Returns:

the Splunk authorization token

setAuthzToken

public void setAuthzToken(String authzToken)

Sets the Splunk authorization token required for making HTTP event collector calls.

Parameters:

authzToken - the Splunk authorization token

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.