Event SPI 

The IBM® Connections Event SPI allows third parties to consume event data generated by IBM Connections.

In version 3, support was added for auditing and compliance. For more information about this support, see Auditing and Compliance enablement.

The Event SPI is an important part of auditing and compliance enablement. By contributing Java™ code written to this SPI, independent applications can plug into the creation, deletion, and update of content within IBM Connections, and in some cases influence the creation, deletion, or update of that content. There are various potential uses for the SPI, such as:

What are events?

Events are collections of data generated when certain activities occur in the IBM Connections product. Typically, events are generated for any activity that represents the creation, update, or deletion of content, changes in access control or membership, and other such activity. Generally, read activity does not result in the generation of events. Events contain a set of standard metadata, as well as optional data sets that may be present for certain event types. Every event can also contain arbitrary properties. In the SPI, an event is represented by a Java Event interface. For a list of the events available in IBM Connections, see the Events Reference wiki article.

What is an event handler?

An event handler is a independently contributed piece of code written to the Event SPI. There are two types of event handlers:

Pre-event handler

Post-event handler

The use of pre-event handlers and synchronous post-event handlers is limited to certain system functions for moderation. Not all events within the system will trigger these handlers. Asynchronous post-event handlers are capable of being triggered for any event generated by the system.

See Programming an event handler for details about how to program an event handler. Documentation of the event handler SPI interfaces is available in the Event SPI Javadoc.

Event handler deployment and registration

Event handlers must be deployed to the IBM Connections system, and also registered in the events-config.xml configuration file. See Deploying an event handler for more details.

Parent topic

IBM Connections SPIs

December 20, 2011 10:21:45 AM


Dec 20, 2011 10:21:45 AM 1