Package org.forgerock.audit.events.handlers

Interface AuditEventHandler

All Known Implementing Classes:

AuditEventHandlerBase, CsvAuditEventHandler, ElasticsearchAuditEventHandler, JdbcAuditEventHandler, JmsAuditEventHandler, JsonAuditEventHandler, JsonStdoutAuditEventHandler, NoOpAuditEventHandler, SplunkAuditEventHandler, SyslogAuditEventHandler

public interface AuditEventHandler

The interface for an AuditEventHandler.

Implementations may make use of DependencyProvider to obtain dependencies from the product within which the audit service is deployed. Where DependencyProvider is used, the dependencies that it is expected to provide should be clearly documented.

Method Summary

Modifier and Type	Method	Description
Set<String>	getHandledTopics()	Gets the names of all audit event topics this handler is registered against.
String	getName()	Gets the name of this audit event handler.
Promise<ActionResponse,ResourceException>	handleAction(Context context, String topic, ActionRequest request)	Performs an action.
boolean	isEnabled()	Checks if the audit event handler is enabled.
Promise<ResourceResponse,ResourceException>	publishEvent(Context context, String topic, JsonValue event)	Publishes an event to the provided topic.
Promise<QueryResponse,ResourceException>	queryEvents(Context context, String topic, QueryRequest query, QueryResourceHandler handler)	Query some events from the provided topic.
Promise<ResourceResponse,ResourceException>	readEvent(Context context, String topic, String resourceId)	Reads an event with the provided resource id from the provided topic.
void	shutdown()	Instruct this object to flush any buffers and close any open file handles or network connections.
void	startup()	Instruct this object that it is safe to initialize file handles and network connections.

Method Detail

startup

void startup()
      throws ResourceException

Instruct this object that it is safe to initialize file handles and network connections.

Reconfiguration of the AuditService and its handlers is achieved by replacing rather than modifying the existing objects. Therefore, it's essential that the replacements do not perform any I/O that would interfere with the operation of the objects they are replacing until the old objects are shutdown. For example, when shutting down an old instance of a file-based AuditEventHandler, the old instance may need to flush buffers, apply file rotation or retention policies, or even add line or block signatures as part of tamper evident logging. Any of these operations could be broken if two handler instances are operating on the same set of files simultaneously.

Throws:

ResourceException - if starting the AuditEventHandler fails

shutdown

void shutdown()
       throws ResourceException

Instruct this object to flush any buffers and close any open file handles or network connections.

Throws:

ResourceException - if closing the AuditEventHandler fails

getName

String getName()

Gets the name of this audit event handler.

Returns:

this handler's name.

getHandledTopics

Set<String> getHandledTopics()

Gets the names of all audit event topics this handler is registered against.

Returns:

the names of all topics handled by this object.

publishEvent

Promise<ResourceResponse,ResourceException> publishEvent(Context context,
                                                               String topic,
                                                               JsonValue event)

Publishes an event to the provided topic.

Note for implementors, it is imperative that the supplied event is not modified in any way as this may cause undesirable behaviour where multiple handlers are configured. If the event must be modified, then make a copy of it and work with that.

Parameters:

context - The context chain that initiated the event.

topic - The topic where to publish the event.

event - The event to publish - which should be considered immutable.

Returns:

a promise with either a response or an exception

readEvent

Promise<ResourceResponse,ResourceException> readEvent(Context context,
                                                            String topic,
                                                            String resourceId)

Reads an event with the provided resource id from the provided topic.

Parameters:

context - The context chain that initiated the event.

topic - The topic where event is read.

resourceId - The identifier of the event.

Returns:

a promise with either a response or an exception

queryEvents

Promise<QueryResponse,ResourceException> queryEvents(Context context,
                                                           String topic,
                                                           QueryRequest query,
                                                           QueryResourceHandler handler)

Query some events from the provided topic.

Parameters:

context - The context chain that initiated the event.

topic - The topic on which query is performed.

query - The request with the query.

handler - The handler to process responses for the query.

Returns:

a promise with either a response or an exception

isEnabled

boolean isEnabled()

Checks if the audit event handler is enabled.

Returns:

whether or not the audit event handler is enabled

handleAction

Promise<ActionResponse,ResourceException> handleAction(Context context,
                                                             String topic,
                                                             ActionRequest request)

Performs an action.

Parameters:

context - The context chain that initiated the event.

topic - The topic on which action is performed.

request - The request with the action.

Returns:

a promise with either a response or an exception