oracle.idm.provisioning.plugin
Interface IEventsFromOID

All Superinterfaces:

IEventPlugin

public interface IEventsFromOID

extends IEventPlugin

Applications interested in receiving changes from OID should implement this interface. The applications register with the OID for the changes occurring at OID. The DIP engine would instantiate an object of this class and invoke the initialize(), sendEventsToApp(), and truncate() method in the same sequence. The initialize method would provide the appropriate information from the profile in the form of a java.util.Hashtable object. The property names, i.e. the hash table key that could be used by the interface implementer will be defined as constants in this interface.

Since:

OCS v3

Method Summary

void	initialize(java.lang.Object prop) Initialize.
EventStatus[]	sendEventsToApp(Event[] evts) OID Events are deliverd to the application through this method.

Methods inherited from interface oracle.idm.provisioning.plugin.IEventPlugin

terminate

Method Detail

initialize

public void initialize(java.lang.Object prop)
                throws EventPluginInitException

Initialize. The application would provide any initialization logic through method. The DIP engine after instantiating a class that implements this interface will first invoke this method.

Specified by:

initialize in interface IEventPlugin

Parameters:

prop - A HashMap that would contain necessary information exposed to the applications

Throws:

EventInitializationException - the applications must throw this exception in case of error.

EventPluginInitException

sendEventsToApp

public EventStatus[] sendEventsToApp(Event[] evts)
                              throws EventDeliveryException

OID Events are deliverd to the application through this method.

Parameters:

evts - an array of LDAPEvent objects returned by the DIP engine

Returns:

the application logc must process these events and return the status of the processed events

Throws:

EventDeliveryException - the applications must throw this exception in case of any error.