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

Version:

$Header: IEventsFromOID.java 31-may-2006.12:57:58 stlee Exp $

Author:

svenugop

Method Summary

Modifier and Type	Method and Description
void	initialize(java.lang.Object provProfile) Initialize.
EventStatus[]	sendEventsToApp(Event[] evts) OID Events are deliverd to the application through this method.
void	terminate(java.lang.Object prof) The applications can perform the termination logic in this method.

Method Detail

initialize

void initialize(java.lang.Object provProfile)
         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:

provProfile - The Provisioning Profile object that would contain necessary information exposed to the applications

Throws:

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

EventPluginInitException

sendEventsToApp

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.

terminate

void terminate(java.lang.Object prof)
        throws PluginException

Description copied from interface: IEventPlugin

The applications can perform the termination logic in this method.

Specified by:

terminate in interface IEventPlugin

Parameters:

prof - Provisioning Profile Object will be sent. refer to oracle.ldap.odip.engine.ProvProfile for more details

Throws:

PluginException - when an exception occurs.