org.forgerock.audit.handlers.jms

Class JmsAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.jms.JmsAuditEventHandler

All Implemented Interfaces:

AuditEventHandler

public class JmsAuditEventHandler
extends AuditEventHandlerBase

Publishes Audit events on a JMS Topic.

Field Summary

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

eventTopicsMetaData

Constructor Summary

Constructors

Constructor and Description
JmsAuditEventHandler(JmsContextManager jmsContextManager, JmsAuditEventHandlerConfiguration configuration, EventTopicsMetaData eventTopicsMetaData) Creates a new AuditEventHandler instance that publishes JMS messages on a JMS Topic for each Audit event.

Method Summary

Modifier and Type	Method and Description
Promise<ResourceResponse,ResourceException>	publishEvent(Context context, String auditTopic, JsonValue auditEvent) Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.
Promise<QueryResponse,ResourceException>	queryEvents(Context context, String topic, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler) Returns NotSupportedException as query is not implemented for JMS.
Promise<ResourceResponse,ResourceException>	readEvent(Context context, String topic, String resourceId) Returns NotSupportedException as read is not implemented for JMS.
void	shutdown() Closes the JMS connection.
void	startup() Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.

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

Constructor Detail

JmsAuditEventHandler

@Inject
public JmsAuditEventHandler(JmsContextManager jmsContextManager,
                                    JmsAuditEventHandlerConfiguration configuration,
                                    EventTopicsMetaData eventTopicsMetaData)
                             throws ResourceException

Creates a new AuditEventHandler instance that publishes JMS messages on a JMS Topic for each Audit event.

Parameters:

jmsContextManager - optional injected JmsContextManager.

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

eventTopicsMetaData - Meta-data for all audit event topics.

Throws:

ResourceException - If JMS connections cannot be established.

Method Detail

startup

public void startup()
             throws ResourceException

Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.

Throws:

ResourceException - if starting the AuditEventHandler fails

shutdown

public void shutdown()
              throws ResourceException

Closes the JMS connection.

Throws:

ResourceException - if closing the AuditEventHandler fails

publishEvent

public Promise<ResourceResponse,ResourceException> publishEvent(Context context,
                                                                String auditTopic,
                                                                JsonValue auditEvent)

Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.

Parameters:

context - The context chain that initiated the event.

auditTopic - The Audit Topic for which the auditEvent was created for. (Not to be confused with a JMS Topic)

auditEvent - The event to convert to a JMS TextMessage and publish on the JMS Topic.

Returns:

a promise with either a response or an exception

queryEvents

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

Returns NotSupportedException as query is not implemented for JMS.
Query some events from the provided topic.

Parameters:

context - The context chain that initiated the event.

topic - The topic on which query is performed.

queryRequest - The request with the query.

queryResourceHandler - The handler to process responses for the query.

Returns:

NotSupportedException as query is not implemented for JMS.

readEvent

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

Returns NotSupportedException as read is not implemented for JMS.
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:

NotSupportedException as read is not implemented for JMS.