Package org.forgerock.audit.handlers.jms

Class JmsAuditEventHandlerConfiguration

java.lang.Object

org.forgerock.audit.events.handlers.EventHandlerConfiguration

org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration

public class JmsAuditEventHandlerConfiguration
extends EventHandlerConfiguration

Configuration object for the JmsAuditEventHandler.

This configuration object can be created from JSON. Example of valid JSON configuration:

 {
     "name" : "jms",
     "topics": [ "access", "activity", "config", "authentication" ],
     "deliveryMode" : "NON_PERSISTENT",
     "sessionMode" : "AUTO",
     "jndi" :  {
          "contextProperties" : {
              "initialContextFactory" : "org.apache.activemq.jndi.ActiveMQInitialContextFactory",
              "providerUrl" : "tcp://localhost:61616"
          },
          "topicName" : "audit",
          "connectionFactoryName" : "connectionFactory"
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsAuditEventHandlerConfiguration.BatchConfiguration	This class holds the configuration properties that are used by the {#link BatchPublisher} to control the batch queue and worker threads that process the items in the queue.
static class	JmsAuditEventHandlerConfiguration.JndiConfiguration	Stores the JNDI context properties and lookup names.

Constructor Summary

Constructors

Constructor	Description
JmsAuditEventHandlerConfiguration()

Method Summary

Modifier and Type	Method	Description
JmsAuditEventHandlerConfiguration.BatchConfiguration	getBatch()	Returns the configuration used to initialize the batch publisher.
DeliveryModeConfig	getDeliveryMode()	Returns the delivery mode configuration that should be used when publishing the JMS messages.
JmsAuditEventHandlerConfiguration.JndiConfiguration	getJndi()	Gets the JmsAuditEventHandlerConfiguration.JndiConfiguration.
SessionModeConfig	getSessionMode()	Returns the mode that the JMS session should use when publishing the JMS messages.
boolean	isUsableForQueries()	States if an AuditEventHandler can be used for queries.
void	setBatch(JmsAuditEventHandlerConfiguration.BatchConfiguration batch)	Sets the configuration used to initialize the batch publisher.
void	setDeliveryMode(DeliveryModeConfig deliveryMode)	Sets the delivery mode configuration that should be used when publishing the JMS messages.
void	setJndi(JmsAuditEventHandlerConfiguration.JndiConfiguration jndi)	Sets the JmsAuditEventHandlerConfiguration.JndiConfiguration.
void	setSessionMode(SessionModeConfig sessionMode)	Sets the session mode that the JMS session should use when publishing the JMS messages.

Methods inherited from class org.forgerock.audit.events.handlers.EventHandlerConfiguration

getName, getTopics, isEnabled, setEnabled, setName, setTopics

Methods inherited from class java.lang.Object

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

Constructor Details

JmsAuditEventHandlerConfiguration

public JmsAuditEventHandlerConfiguration()

Method Details

getDeliveryMode

public DeliveryModeConfig getDeliveryMode()

Returns the delivery mode configuration that should be used when publishing the JMS messages.

Returns:

the delivery mode.

setDeliveryMode

public void setDeliveryMode(DeliveryModeConfig deliveryMode)

Sets the delivery mode configuration that should be used when publishing the JMS messages.

Parameters:

deliveryMode - the delivery mode

getSessionMode

public SessionModeConfig getSessionMode()

Returns the mode that the JMS session should use when publishing the JMS messages.

Returns:

the session's mode.

See Also:

• Session.getAcknowledgeMode()

setSessionMode

public void setSessionMode(SessionModeConfig sessionMode)

Sets the session mode that the JMS session should use when publishing the JMS messages.

Parameters:

sessionMode - the session's acknowledgement mode.

See Also:

• Session.getAcknowledgeMode()

getBatch

public JmsAuditEventHandlerConfiguration.BatchConfiguration getBatch()

Returns the configuration used to initialize the batch publisher.

Returns:

the configuration used to initialize the batch publisher.

setBatch

public void setBatch(JmsAuditEventHandlerConfiguration.BatchConfiguration batch)

Sets the configuration used to initialize the batch publisher.

Parameters:

batch - the configuration used to initialize the batch publisher.

getJndi

public JmsAuditEventHandlerConfiguration.JndiConfiguration getJndi()

Gets the JmsAuditEventHandlerConfiguration.JndiConfiguration.

Returns:

The JmsAuditEventHandlerConfiguration.JndiConfiguration.

setJndi

public void setJndi(JmsAuditEventHandlerConfiguration.JndiConfiguration jndi)

Sets the JmsAuditEventHandlerConfiguration.JndiConfiguration.

Parameters:

jndi - The JmsAuditEventHandlerConfiguration.JndiConfiguration

isUsableForQueries

public boolean isUsableForQueries()

Description copied from class: EventHandlerConfiguration

States if an AuditEventHandler can be used for queries.

Specified by:

isUsableForQueries in class EventHandlerConfiguration

Returns:

True - If the AuditEventHandler can be used for queries. False - If the AuditEventHandler can not be used for queries.