Class JmsAuditEventHandler

java.lang.Object
org.forgerock.audit.events.handlers.AuditEventHandlerBase
org.forgerock.audit.handlers.jms.JmsAuditEventHandler
All Implemented Interfaces:
AuditEventHandler, BatchConsumer

public class JmsAuditEventHandler extends AuditEventHandlerBase implements BatchConsumer
Publishes Audit events on a JMS Topic.
  • Constructor Details

  • Method Details

    • startup

      public void startup() throws ResourceException
      Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.
      Specified by:
      startup in interface AuditEventHandler
      Throws:
      ResourceException - if starting the AuditEventHandler fails
    • shutdown

      public void shutdown() throws ResourceException
      Closes the JMS connection.
      Specified by:
      shutdown in interface AuditEventHandler
      Throws:
      ResourceException - if closing the AuditEventHandler fails
    • queryEvents

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

      Returns NotSupportedException as query is not implemented for JMS.

      Query some events from the provided topic.
      Specified by:
      queryEvents in interface AuditEventHandler
      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(org.forgerock.services.context.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.
      Specified by:
      readEvent in interface AuditEventHandler
      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.
    • publishEvent

      public Promise<ResourceResponse,ResourceException> publishEvent(org.forgerock.services.context.Context context, String topic, JsonValue event)
      Description copied from interface: AuditEventHandler
      Publishes an event to the provided topic.

      Note for implementors, it is imperative that the supplied event is not modified in any way as this may cause undesirable behaviour where multiple handlers are configured. If the event must be modified, then make a copy of it and work with that.

      Specified by:
      publishEvent in interface AuditEventHandler
      Parameters:
      context - The context chain that initiated the event.
      topic - The topic where to publish the event.
      event - The event to publish - which should be considered immutable.
      Returns:
      a promise with either a response or an exception
    • addToBatch

      public void addToBatch(String topic, JsonValue event, StringBuilder payload) throws BatchException
      Description copied from interface: BatchConsumer
      Adds an audit event to a batch payload.
      Specified by:
      addToBatch in interface BatchConsumer
      Parameters:
      topic - event topic
      event - event JSON payload
      payload - batch payload
      Throws:
      BatchException - indicates failure to add-to-batch
    • publishBatch

      public Promise<Void,BatchException> publishBatch(String payload)
      Description copied from interface: BatchConsumer
      Publishes the batch payload.
      Specified by:
      publishBatch in interface BatchConsumer
      Parameters:
      payload - batch payload
      Returns:
      a simple promise encapsulating any potential batch exception