Package org.forgerock.audit.handlers.jdbc

Class JdbcAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler

All Implemented Interfaces:

org.forgerock.audit.events.handlers.AuditEventHandler

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

Implements a AuditEventHandler to write AuditEvents to a JDBC repository.

Field Summary

Fields

Modifier and Type	Field	Description
static String	H2	The name used for an H2 database.
static String	MYSQL	The name used for a MySQL database.
static String	ORACLE	The name used for an Oracle database.

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

eventTopicsMetaData

Constructor Summary

Constructors

Constructor	Description
JdbcAuditEventHandler(JdbcAuditEventHandlerConfiguration configuration, org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData, DataSource dataSource)	Create a new JdbcAuditEventHandler instance.

Method Summary

Modifier and Type	Method	Description
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)
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 queryRequest, org.forgerock.json.resource.QueryResourceHandler queryResourceHandler)
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)
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

Field Detail

MYSQL

public static final String MYSQL

The name used for a MySQL database.

See Also:

Constant Field Values

H2

public static final String H2

The name used for an H2 database.

See Also:

Constant Field Values

ORACLE

public static final String ORACLE

The name used for an Oracle database.

See Also:

Constant Field Values

Constructor Detail

JdbcAuditEventHandler

@Inject
public JdbcAuditEventHandler(JdbcAuditEventHandlerConfiguration configuration,
                             org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData,
                             DataSource dataSource)

Create a new JdbcAuditEventHandler instance.

Parameters:

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

eventTopicsMetaData - Meta-data for all audit event topics.

dataSource - Connection pool. If this parameter is null, then a Hikari data source will be created.

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)

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 queryRequest,
                                                                                                                                                     org.forgerock.json.resource.QueryResourceHandler queryResourceHandler)

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)