Overview of Event Notification Plug-in Service Provider Interface (SPI)

This section introduces software developers to the Event Notification SPI A Service Provider Interface (SPI) consists of a set of constant definitions and method declarations without implementations and intended to be called or used in a pre-determined generic manner with a set of outputs that meet pre-determined abstract rules and expectations., and briefly describes how to develop an event notification plug-in to process events that are generated by the ActivID Credential Management System (CMS). This section also provides information about the following Event Notification plug-in topics:

  • Developing, installing, and deploying Event Notification plug-ins

  • Understanding how to deploy the sample Java plug-in

  • Understanding the classes associated with creating plug-ins that respond to specific types of event objects

  • Understanding the events generated by ActivID CMS to which Event Notification plug-ins can respond

  • Understanding the attributes and logical step IDs returned by event objects

For a complete list of all of the classes that comprise the Event Notification Plug-in SPI, see the Javadocs that accompany this release.

For detailed information about developing plug-ins using the Event Notification plug-in SPI, see Developing an Event Notification Plug-In.

The ActivID CMS event notification plug-in mechanism enables third-party developers to cause events that occur in ActivID CMS to trigger execution of code external to ActivID CMS.

Prerequisites: The Event Notification Plug-In SPI 4.1.1 is a Java-based interface; Event Notification plug-in implementations and their dependent components must support the Java Developer Kit running ActivID CMS (JDK 11 by default). Where native binaries are included in the Event Notification plug-in implementation, they must support the target ActivID CMS operating systems.
Note: JDK version 11 removes some deprecated interfaces and classes (such as the com.sun.* and sun.* packages); consequently, your code must not depend on any of these removed features (for details, see JDK 11 Removed Features and Options).