oracle.idm.provisioning.plugin

Interface IEventsToOID

All Superinterfaces:

IEventPlugin

public interface IEventsToOID
extends IEventPlugin

Applications interested in sending changes to OID should implement this interface. The applications must register with the OID for the sending changes at their end to DIP. The DIP engine would instantiate an object of this class and invoke the initialize(), sendEventsFromApp(), 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: IEventsToOID.java 09-jun-2005.12:45:53 vasokkum Exp $

Author:

svenugop

Method Summary

Modifier and Type	Method and Description
boolean	hasMore() Application can let the DIP engine know whether there are more event to follow through this method
void	initialize(java.lang.Object profile) Initialize.
Event[]	receiveEventsFromApp() Application Events are deliverd to OID through this method.
void	setAppEventStatus(EventStatus[] evtStatus) The status of the application events are intimated through this method.

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

terminate

Method Detail

initialize

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

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

Throws:

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

receiveEventsFromApp

Event[] receiveEventsFromApp()
                      throws EventDeliveryException

Application Events are deliverd to OID through this method.

Returns:

an array of Event objects returned to be processed by the DIP engine.

Throws:

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

hasMore

boolean hasMore()
         throws PluginException

Application can let the DIP engine know whether there are more event to follow through this method

Returns:

ture if there are more events to be returned and false otherwise

Throws:

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

setAppEventStatus

void setAppEventStatus(EventStatus[] evtStatus)
                throws EventDeliveryException

The status of the application events are intimated through this method. i.e the DIP engine after processing the events calls this method to set the event status.

Parameters:

evtStatus - an array of Event status objects describing the processed event status by the DIP engine.

Throws:

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