Index
All Classes and Interfaces|All Packages
A
- AUTO - Enum constant in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Auto-acknowledge session mode.
B
- BatchPublisher<T> - Class in org.forgerock.audit.handlers.jms
-
Generic publisher that will queue anything for batch processing.
- BatchPublisher(String, BatchPublisherConfiguration) - Constructor for class org.forgerock.audit.handlers.jms.BatchPublisher
-
This constructs the thread pool of worker threads.
- BatchPublisherConfiguration - Class in org.forgerock.audit.handlers.jms
-
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.
- BatchPublisherConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
C
- CLIENT - Enum constant in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Client-acknowledge session mode.
D
- DeliveryModeConfig - Enum in org.forgerock.audit.handlers.jms
-
Configuration wrapper for JMS
DeliveryMode
persistence constants. - DUPS_OK - Enum constant in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Dups-OK-acknowledge session mode.
G
- getBatch() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Returns the configuration used to initialize the batch publisher.
- getCapacity() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns the maximum capacity of the publishing queue.
- getConnectionFactory() - Method in interface org.forgerock.audit.handlers.jms.JmsContextManager
-
Gets a
JMS connection factory
. - getConnectionFactoryName() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Returns the jndi lookup name for the JMS
ConnectionFactory
to which messages will be published. - getContextProperties() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Gets the Jndi
InitialContext
properties. - getDeliveryMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Returns the delivery mode configuration that should be used when publishing the JMS messages.
- getInsertTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns the timeout in seconds the duration that the queue should block while attempting to offer a new item for the queue.
- getJndi() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
- getMaxBatchedEvents() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns the maximum count of events that will be expected to be delivered in a single publish call.
- getMode() - Method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig
-
Returns the DeliveryMode value for this configuration.
- getMode() - Method in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Returns the session mode setting for this configuration.
- getPollTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns the timeout in seconds for the worker threads to wait for a new item to be available in the queue before exiting.
- getSessionMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Returns the mode that the JMS session should use when publishing the JMS messages.
- getShutdownTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returnds the timeout in seconds for the publisher to wait for all worker threads to terminate at shutdown.
- getThreadCount() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns the count of worker threads to have processing the queue.
- getTopic() - Method in interface org.forgerock.audit.handlers.jms.JmsContextManager
-
Gets a
JMS topic
. - getTopicName() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Returns the jndi lookup name for the JMS
Topic
to which messages will be published.
I
- isBatchEnabled() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Returns true if handling of audit events should be done in batches.
- isUsableForQueries() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
J
- JmsAuditEventHandler - Class in org.forgerock.audit.handlers.jms
-
Publishes Audit events on a JMS Topic.
- JmsAuditEventHandler(JmsContextManager, JmsAuditEventHandlerConfiguration, EventTopicsMetaData) - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Creates a new AuditEventHandler instance that publishes JMS messages on a JMS Topic for each Audit event.
- JmsAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.jms
-
Configuration object for the
JmsAuditEventHandler
. - JmsAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
- JmsAuditEventHandlerConfiguration.JndiConfiguration - Class in org.forgerock.audit.handlers.jms
-
Stores the JNDI context properties and lookup names.
- JmsContextManager - Interface in org.forgerock.audit.handlers.jms
-
Interface for retrieving a
JMS topic
and aJMS connection factory
. - JndiConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
N
- NON_PERSISTENT - Enum constant in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig
-
A non-persistent delivery mode.
O
- org.forgerock.audit.handlers.jms - package org.forgerock.audit.handlers.jms
-
This package contains a JMS AuditEventHandler implementation.
P
- PERSISTENT - Enum constant in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig
-
A persistent delivery mode.
- publish(T) - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
Offers the message to the queue.
- publish(T) - Method in interface org.forgerock.audit.handlers.jms.Publisher
-
implement this to deliver the audit event representation to the service.
- Publisher<T> - Interface in org.forgerock.audit.handlers.jms
-
Defines a generic interface for audit event publishers.
- publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.
- publishMessages(List<T>) - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
This is invoked by the worker threads to have the passed in messages published immediately.
Q
- queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Returns NotSupportedException as query is not implemented for JMS.
R
- readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Returns NotSupportedException as read is not implemented for JMS.
S
- SessionModeConfig - Enum in org.forgerock.audit.handlers.jms
-
Configuration wrapper for JMS
Session.getAcknowledgeMode()
SessionMode setting. - setBatch(BatchPublisherConfiguration) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Sets the configuration used to initialize the batch publisher.
- setBatchEnabled(boolean) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
sets if handling of audit events should be done in batches.
- setCapacity(int) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the maximum capacity of the publishing queue.
- setContextProperties(Map<String, String>) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Sets the Jndi
InitialContext
properties. - setDeliveryMode(DeliveryModeConfig) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Sets the delivery mode configuration that should be used when publishing the JMS messages.
- setInsertTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the timeout in seconds the duration that the queue should block while attempting to offer a new item for the queue.
- setJmsConnectionFactoryName(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Sets the jndi lookup name for the JMS
ConnectionFactory
for which the messages will be published on. - setJmsTopicName(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
-
Sets the jndi lookup name for the JMS
Topic
for which the messages will be published on. - setJndi(JmsAuditEventHandlerConfiguration.JndiConfiguration) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
- setMaxBatchedEvents(int) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the maximum count of events that will be expected to be delivered in a single publish call.
- setPollTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the timeout in seconds for the worker threads to wait for a new item to be available in the queue before exiting.
- setSessionMode(SessionModeConfig) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
-
Sets the session mode that the JMS session should use when publishing the JMS messages.
- setShutdownTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the timeout in seconds for the publisher to wait for all worker threads to terminate at shutdown.
- setThreadCount(int) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
-
Sets the count of worker threads to have processing the queue.
- shutdown() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
This shutdowns the worker threads, and then calls
BatchPublisher.shutdownPublisher()
. - shutdown() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Closes the JMS connection.
- shutdown() - Method in interface org.forgerock.audit.handlers.jms.Publisher
-
Cleanup services that were initialized with
Publisher.startup()
. - shutdownPublisher() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
This is invoked by
BatchPublisher.shutdown()
. - startup() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
This first initializes the worker threads that monitor the queue of items to publish, and then calls
BatchPublisher.startupPublisher()
. - startup() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
-
Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.
- startup() - Method in interface org.forgerock.audit.handlers.jms.Publisher
-
Initialize services that are reused by individual publish calls.
- startupPublisher() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
-
This is invoked by
BatchPublisher.startup()
.
V
- valueOf(String) - Static method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.forgerock.audit.handlers.jms.SessionModeConfig
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages