Package org.forgerock.audit.handlers.csv

Class CsvAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.csv.CsvAuditEventHandler

All Implemented Interfaces:

org.forgerock.audit.events.handlers.AuditEventHandler

public class CsvAuditEventHandler
extends org.forgerock.audit.events.handlers.AuditEventHandlerBase

Handles AuditEvents by writing them to a CSV file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CsvAuditEventHandler.ParseJsonValue	CellProcessor for parsing JsonValue objects from CSV file.

Field Summary

Fields

Modifier and Type	Field	Description
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	Description
CsvAuditEventHandler(CsvAuditEventHandlerConfiguration configuration, org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData, org.forgerock.audit.providers.KeyStoreHandlerProvider keyStoreHandlerProvider)	Create a new CsvAuditEventHandler instance.

Method Summary

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>	handleAction(org.forgerock.services.context.Context context, String topic, org.forgerock.json.resource.ActionRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	publishEvent(org.forgerock.services.context.Context context, String topic, org.forgerock.json.JsonValue event)	Create a csv audit log entry.
org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>	queryEvents(org.forgerock.services.context.Context context, String topic, org.forgerock.json.resource.QueryRequest query, org.forgerock.json.resource.QueryResourceHandler handler)	Perform a query on the csv audit log.
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	readEvent(org.forgerock.services.context.Context context, String topic, String resourceId)	Read from the csv audit log.
void	shutdown()
void	startup()

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

Constructor Detail

CsvAuditEventHandler

@Inject
public CsvAuditEventHandler(CsvAuditEventHandlerConfiguration configuration,
                            org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData,
                            org.forgerock.audit.providers.KeyStoreHandlerProvider keyStoreHandlerProvider)

Create a new CsvAuditEventHandler instance.

Parameters:

configuration - Configuration parameters that can be adjusted by system administrators.

eventTopicsMetaData - Meta-data for all audit event topics.

keyStoreHandlerProvider - The secure storage to use for keys.

Method Detail

startup

public void startup()
             throws org.forgerock.json.resource.ResourceException

Throws:

org.forgerock.json.resource.ResourceException

shutdown

public void shutdown()
              throws org.forgerock.json.resource.ResourceException

Throws:

org.forgerock.json.resource.ResourceException

publishEvent

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

Create a csv audit log entry.

queryEvents

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

Perform a query on the csv audit log.

readEvent

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

Read from the csv audit log.

handleAction

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> handleAction(org.forgerock.services.context.Context context,
                                                                                                                                                       String topic,
                                                                                                                                                       org.forgerock.json.resource.ActionRequest request)

Specified by:

handleAction in interface org.forgerock.audit.events.handlers.AuditEventHandler

Overrides:

handleAction in class org.forgerock.audit.events.handlers.AuditEventHandlerBase