org.forgerock.openam.audit

Interface AuditEventHandlerFactory

All Known Implementing Classes:

CsvAuditEventHandlerFactory, ElasticsearchAuditEventHandlerFactory, JdbcAuditEventHandlerFactory, JmsAuditEventHandlerFactory, JsonStdoutAuditEventHandlerFactory, SplunkAuditEventHandlerFactory, SyslogAuditEventHandlerFactory

public interface AuditEventHandlerFactory

A factory for creating an audit event handler. Implementations of this interface are required to create an instance of AuditEventHandler, based on the configuration attributes supplied. Instances of AuditEventHandlerFactory are injected with Guice and implementation class names can be configured in the Audit Logging Configuration Service.

Since:

13.0.0

See Also:

AuditEventHandler

Method Summary

Modifier and Type	Method and Description
org.forgerock.audit.events.handlers.AuditEventHandler	create(AuditEventHandlerConfiguration configuration) Create an instance of AuditEventHandler.

Method Detail

create

org.forgerock.audit.events.handlers.AuditEventHandler create(AuditEventHandlerConfiguration configuration)
                                                      throws org.forgerock.audit.AuditException

Create an instance of AuditEventHandler. This method will be called every time configuration for audit logging in OpenAM has changed. The returned handler will be added to the appropriate AuditService, which will in turn call AuditEventHandler.startup(). If this method returns null then nothing will be added to the AuditService.

Parameters:

configuration - The configuration properties to use when creating the handler.

Returns:

An instance of AuditEventHandler or null if this handler is disabled.

Throws:

org.forgerock.audit.AuditException - If an error occurred during creation of the handler.