Novell Documentation: Novell Nsure Identity Manager Driver Kit - Implementing the SubscriptionShim Interface

2.6 Implementing the SubscriptionShim Interface

The SubscriptionShim interface consists of two methods:

SubscriptionShim init—performs subscriber channel-specific initialization.
SubscriptionShim execute—accepts commands from the DirXML engine and executes those commands on the application. The execute method is inherited from the XmlCommandProcessor interface.

When the DirXML engine initializes a DirXML driver, the engine adds the driver to its notification list for eDirectory events. When an eDirectory event occurs, the engine converts the eDirectory data to XML and sends it to the subscriber.

The subscriber needs to be configured for an eDirectory filter. The DirXML engine uses the filter to register the DirXML driver for the appropriate eDirectory events and then filters the data to the appropriate objects and attributes.

The DirXML driver also needs to be configured for mapping, creation, matching, placement, and optionally, event transformation rules. The DirXML engine converts eDirectory data to XML and applies these rules before sending the data to the subscriber. These rules allow the system administrator to determine what data and how the data is shared between the two. For more information, see Introduction to the Rules and Filters.

The subscriber requires four main routines, three of which are driver-specific:

Driver-specific: the initialization process.
Driver-specific: the process for converting the XML formatted data into the external database's native format.
Driver-specific: the process that sends the data to the external database. You must use the application's programming interface for this process.
Generic to all drivers: the query callback process that requests more information from eDirectory before performing an update to the external application.

The SubscriptionShim interface inherits from the XmlCommandProcessor interface.

For Javadoc, see SubscriptionShim.