15.2 Working with the Oracle Provisioning Event Engine

The Oracle provisioning event engine generates events from add, modify, and delete operations that are performed on well-defined objects in Oracle Internet Directory. The Oracle provisioning event engine uses object definitions and event generation rules to generate events. This event generation model is very extensible because it enables you to define custom objects and event generation rules. The Oracle provisioning event engine object definitions and event generation rules are discussed in the following topics:

Creating Custom Event Object Definitions
Defining Custom Event Generation Rules

15.2.1 Creating Custom Event Object Definitions

Table 15-1 lists the properties that you can use to identify objects for which events can be generated.

Table 15-1 Event Object Properties

Property	Description
`ObjectName`	Assigns a unique name to identify the object
`ObjectCriteria`	Identifies the LDAP object class to use for identifying the object
`MustAttributeCriteria`	Provides any additional attributes that are required for identifying the object
`OptionalAttributeCriteria`	Provides any optional attributes that may be required for identifying the object
`FilterAttributeCriteria`	Lists the attributes that should not be sent during event propagation

Table 15-2 lists the predefined objects for which the Oracle provisioning event engine can generate events.

Table 15-2 Predefined Event Objects

Object Name	Valid Object Class Values
`Entry`	`*`
`User`	`orclUserV2`, `inetorgperson`
`Identity`	`orclUserV2`, `inetOrgPerson`
`Group`	`groupOfUniqueNames`, `orclGroup`, `orclPrivilegeGroup`, `groupOfNames`
`Subscription`	`orclServiceSubscriptionDetail`
`Subscriber`	`orclSubscriber`

Note:

The metadata for event objects is stored in the following container: cn=Object Definitions, cn=Directory Integration Platform,cn=Products,cn=OracleContext

15.2.2 Defining Custom Event Generation Rules

You specify event generation rules in XML format. The DTD for event generation rules is as follows:

<?xml version='1.0' ?>
  <!DOCTYPE EventRuleSet [ 
    <!ELEMENT ChangeType (#PCDATA)> 
    <!ELEMENT Rule  (#PCDATA)> 
    <!ELEMENT EventName  (#PCDATA)> 
    <!ELEMENT ResEvent (Rule*, EventName)> 
    <!ELEMENT EventRule (ChangeType, ResEvent*)>
    <!ELEMENT EventRuleSet (EventRule*) >
  ]>

The element definitions in the preceding DTD are as follows:

The EventRuleSet root element identifies a set of event rules for an individual event object.
The EventRuleSet root element contains a list of EventRule elements.
Each EventRule element depends on the value assigned to the ChangeType element.
The ChangeType and Rule elements determine the event name to be propagated to an application.

Table 15-3 lists the event definitions that are supported by the Oracle provisioning event engine.

Table 15-3 Supported Event Definitions

Object Name	Change Type	Rule	Event Name
`USER`	Add	`OrclApplnUserProvStatus=PENDING_UPGRADE`	`USER_ADD`
	Add	`OrclApplnUserProvStatus=PROVISIONING_REQUIRED`	`USER_ADD`

	Modify	`OrclApplnUserProvStatus= PENDING_UPGRADE`	`USER_ADD`
		`OrclApplnUserProvStatus=PROVISIONING_REQUIRED`	`USER_ADD`
		`OrclApplnUserProvStatus=PROVISIONING_FAILURE`	`USER_ADD`
		`OrclApplnUserProvStatus=DEPROVISIONING_REQUIRED`	`USER_MODIFY`
		`OrclApplnUserProvStatus=PROVISIONING_IN_PROGRESS`	`USER_MODIFY`
		`OrclApplnUserProvStatus=PROVISIONING_SUCCESSFUL`	`USER_MODIFY`

	Delete	`OrclApplnUserProvStatus=PROVISIONING_IN_PROGRESS`	`USER_DELETE`
		`OrclApplnUserProvStatus=PROVISIONING_SUCCESSFUL`	`USER_DELETE`
		`OrclApplnUserProvStatus=DEPROVISIONING_REQUIRED`

`GROUP`	Add		`GROUP_ADD`
	Modify		`GROUP_MODIFY`
	Delete		`GROUP_DELETE`

`IDENTITY`	Add		`IDENTITY_ADD`
	Modify		`IDENTITY_MODIFY`
	Delete		`IDENTITY_DELETE`

`ENTRY`	Add		`ENTRY_ADD`
	Modify		`ENTRY_MODIFY`
	Delete		`ENTRY_DELETE`

`SUBSCRIPTION`	Add		`SUBSCRIPTION_ADD`
	Modify		`SUBSCRIPTION_MODIFY`
	Delete		`SUBSCRIPTION_DELETE`

`SUBSCRIBER`	Add		`SUBSCRIBER_ADD`
	Modify		`SUBSCRIBER_MODIFY`
	Delete		`SUBSCRIBER_DELETE`

Note:

The metadata for supported events objects is stored in the following container: cn=Event Definitions, cn=Directory Integration Platform,cn=Products,cn=OracleContext