Package org.forgerock.openam.audit.events.handlers

Class JmsAuditEventHandlerFactory

java.lang.Object

org.forgerock.openam.audit.events.handlers.JmsAuditEventHandlerFactory

All Implemented Interfaces:

AuditEventHandlerFactory

public final class JmsAuditEventHandlerFactory
extends Object
implements AuditEventHandlerFactory

This factory is responsible for creating an instance of the JmsAuditEventHandler.

Since:

13.5.0

Constructor Summary

Constructors

Constructor	Description
JmsAuditEventHandlerFactory()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsAuditEventHandlerFactory

public JmsAuditEventHandlerFactory()

Method Detail

create

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

Description copied from interface: AuditEventHandlerFactory

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.

Specified by:

create in interface AuditEventHandlerFactory

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.