Understanding Event Notification Workflow

Once an event notification plug-in has been installed, whenever an event occurs the following happens:

  1. ActivID CMS performs an operation (for example, device issuance).

  2. Once the operation has completed, ActivID CMS calls each event notification plug-in and passes it an AIMSEvent object. Each AIMSEvent object has a set of public accessors for each of the member attributes. These public accessors enable the event notification plug-in to retrieve all of the relevant information about the event and forward it on to the corresponding external system.

  3. The external code processes the event.

  4. When the plug-in is loaded by ActivID CMS on a Windows system, the working directory is set to be:

%PROGRAMDATA%\HID Global\Credential Management System\custom.war\WEB-INF\lib

where cms_dir represents the directory into which ActivID CMS was installed.

Methods Called When an Event Occurs

When an event occurs, there are different types of methods used for handling each of the event classes. Each event class is described in more detail in the following sections:

Each of the methods are called in response to an event occurrence that takes the AIMSEvent object as its only parameter.

A sample plug-in, NotificationPluginSample.java, is included with the ActivID CMS release in the \CMS\SDK\SPI\Notification directory. The sample plug-in logs all the received events into a file.