org.forgerock.audit.handlers.json

Class JsonAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.json.JsonAuditEventHandler

All Implemented Interfaces:

AuditEventHandler

public class JsonAuditEventHandler
extends AuditEventHandlerBase

AuditEventHandler for persisting raw JSON events to a file.

The file format is a UTF-8 text-file, with one JSON event per line, and each line terminated by a newline character.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLUSH_FILE_ACTION_NAME Name of action to force flushing of file-buffer, which is not the same as flushing buffered audit events, and is primarily used for testing purposes.
static String	ROTATE_FILE_ACTION_NAME Name of action to force file rotation.

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

eventTopicsMetaData

Constructor Summary

Constructors

Constructor and Description
JsonAuditEventHandler(JsonAuditEventHandlerConfiguration configuration, EventTopicsMetaData eventTopicsMetaData) Creates a JsonAuditEventHandler instances.

Method Summary

Modifier and Type	Method and Description
Promise<ActionResponse,ResourceException>	handleAction(Context context, String topic, ActionRequest request) Performs an action.
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.

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

getHandledTopics, getName, isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

ROTATE_FILE_ACTION_NAME

public static final String ROTATE_FILE_ACTION_NAME

Name of action to force file rotation.

See Also:

Constant Field Values

FLUSH_FILE_ACTION_NAME

public static final String FLUSH_FILE_ACTION_NAME

Name of action to force flushing of file-buffer, which is not the same as flushing buffered audit events, and is primarily used for testing purposes.

See Also:

Constant Field Values

Constructor Detail

JsonAuditEventHandler

public JsonAuditEventHandler(JsonAuditEventHandlerConfiguration configuration,
                             EventTopicsMetaData eventTopicsMetaData)

Creates a JsonAuditEventHandler instances.

Parameters:

configuration - Configuration

eventTopicsMetaData - Provides meta-data describing the audit event topics this handler may have to handle.

Method Detail

startup

public void startup()
             throws ResourceException

Description copied from interface: AuditEventHandler

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

public void shutdown()
              throws ResourceException

Description copied from interface: AuditEventHandler

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

Throws:

ResourceException - if closing the AuditEventHandler fails

publishEvent

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

Description copied from interface: AuditEventHandler

Publishes an event to the provided topic.

Parameters:

context - The context chain that initiated the event.

topic - The topic where to publish the event.

event - The event to publish.

Returns:

a promise with either a response or an exception

readEvent

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

Description copied from interface: AuditEventHandler

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

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

Description copied from interface: AuditEventHandler

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

handleAction

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

Description copied from interface: AuditEventHandler

Performs an action.

Specified by:

handleAction in interface AuditEventHandler

Overrides:

handleAction in class AuditEventHandlerBase

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