Event (Oracle Fusion Middleware Java API Reference for Oracle Internet Directory)

java.lang.Object
- oracle.idm.provisioning.event.Event

Direct Known Subclasses:

PlsqlEvent
```
public class Event
extends java.lang.Object
```
Event object that describes the change to be applied to OID or the change that was applied at OID that application needs to know.

Since:

OCS R3

Version:

$Header: ldap/java/src/oracle/idm/provisioning/event/Event.java /main/5 2010/01/06 18:59:33 nkandalu Exp $

Author:

Siva Kumar Venugopal

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTR_TYPE_BINARY`
`static int`	`ATTR_TYPE_DATE_STRING`
`static int`	`ATTR_TYPE_DECRYPTED_STRING`
`static int`	`ATTR_TYPE_ENCRYPTED_STRING`
`static int`	`ATTR_TYPE_STRING`
`protected ModPropertySet`	`m_changes` The List of Attributes changes in this event.
`protected java.lang.String`	`m_eventID` Unique Identifier of the event.
`protected java.lang.String`	`m_eventSrc` The identifier of the object that caused this event.
`protected java.lang.String`	`m_eventTime` The Time of occurrence of the event.
`protected java.lang.String`	`m_eventType` Every Event is identified by a unique string value (understood by both ends).
`protected java.lang.String`	`m_objectDN` For OID, it is the DN of the object that changed.
`protected java.lang.String`	`m_objectGuid` The Unique ID of the Object that changed.
`protected java.lang.String`	`m_objectName` The Name of the object that changed.
`protected java.lang.String`	`m_profileID` The DIP integration profile ID responsible for this change event.

Constructor Summary

Constructors
Constructor and Description
`Event()` Default constructor.
`Event(java.lang.String type, java.lang.String ID, java.lang.String src, java.lang.String time, java.lang.String objName, java.lang.String objGuid, java.lang.String objDN, java.lang.String profID)` Create a event object with all the attributes set.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChanges(javax.naming.directory.Attributes attrs)`
`ModPropertySet`	`getChanges()` Return the changes in the event.
`java.lang.String`	`getID()` Return the event ID.
`java.lang.String`	`getObjDN()` Return the Object DN.
`java.lang.String`	`getObjGuid()` Return the Object GUID.
`java.lang.String`	`getObjName()` Return the Object name.
`java.lang.String`	`getProfileID()` Return the Profile ID.
`java.lang.String`	`getSource()` Return the event source.
`java.lang.String`	`getStatus()` Returns the status
`java.lang.String`	`getTime()` Return the event time.
`java.lang.String`	`getType()` Return the event type.
`static void`	`main(java.lang.String[] s)`
`void`	`setChanges(ModPropertySet chgs)` Set the changes in the event.
`void`	`setID(java.lang.String evtID)` Set the event ID.
`void`	`setObjDN(java.lang.String objDN)` Set the Object DN
`void`	`setObjGuid(java.lang.String objGuid)` Set the Object GUID.
`void`	`setObjName(java.lang.String objName)` Set the Object name.
`void`	`setProfileID(java.lang.String profID)` Set the Profile ID
`void`	`setSource(java.lang.String evtSrc)` Set the event source
`void`	`setStatus(java.lang.String status)` Sets the status
`void`	`setTime(java.lang.String evtTime)` Set the event time
`void`	`setType(java.lang.String evtType)` Set the event type.
`int`	`size()`
`java.lang.String`	`toString()` String representation of the event

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTR_TYPE_STRING
```
public static final int ATTR_TYPE_STRING
```
    See Also:
    
    Constant Field Values
  - ATTR_TYPE_BINARY
```
public static final int ATTR_TYPE_BINARY
```
    See Also:
    
    Constant Field Values
  - ATTR_TYPE_ENCRYPTED_STRING
```
public static final int ATTR_TYPE_ENCRYPTED_STRING
```
    See Also:
    
    Constant Field Values
  - ATTR_TYPE_DATE_STRING
```
public static final int ATTR_TYPE_DATE_STRING
```
    See Also:
    
    Constant Field Values
  - ATTR_TYPE_DECRYPTED_STRING
```
public static final int ATTR_TYPE_DECRYPTED_STRING
```
    See Also:
    
    Constant Field Values
  - m_eventType
```
protected java.lang.String m_eventType
```
    Every Event is identified by a unique string value (understood by both ends).
  - m_eventID
```
protected java.lang.String m_eventID
```
    Unique Identifier of the event. For OID generated events, it is the change number. For applications it could be any kind of sequenced value. This is stored in the provisioning profile.
  - m_eventSrc
```
protected java.lang.String m_eventSrc
```
    The identifier of the object that caused this event. For OID generated events, it is the creators/modifiers DN.
  - m_eventTime
```
protected java.lang.String m_eventTime
```
    The Time of occurrence of the event. This is expected in the UTC format "YYYYMMDDHH24MISSz"
  - m_objectName
```
protected java.lang.String m_objectName
```
    The Name of the object that changed. For OID events, it is the nickname attribute value.
  - m_objectGuid
```
protected java.lang.String m_objectGuid
```
    The Unique ID of the Object that changed. For OID, it is the 32 characters ORCLGUID
  - m_objectDN
```
protected java.lang.String m_objectDN
```
    For OID, it is the DN of the object that changed.
  - m_profileID
```
protected java.lang.String m_profileID
```
    The DIP integration profile ID responsible for this change event. It is of the form <Realm GUID_Application GUID>. If application needs to know which realm a event pertains to, it can use the REALM GUID part of this value.
  - m_changes
```
protected ModPropertySet m_changes
```
    The List of Attributes changes in this event.
- Constructor Detail
  - Event
```
public Event()
```
    Default constructor.
  - Event
```
public Event(java.lang.String type,
             java.lang.String ID,
             java.lang.String src,
             java.lang.String time,
             java.lang.String objName,
             java.lang.String objGuid,
             java.lang.String objDN,
             java.lang.String profID)
```
    Create a event object with all the attributes set.
- Method Detail
  - getType
```
public java.lang.String getType()
```
    Return the event type.
    
    Returns:
    
    the event type
  - setType
```
public void setType(java.lang.String evtType)
```
    Set the event type.
    
    Parameters:
    
    evtType - Event type
  - getID
```
public java.lang.String getID()
```
    Return the event ID. Unique Identifier of the event. For OID generated events, it is the change number. For applications it could be any kind of sequenced value. This is stored in the provisioning profile.
    
    Returns:
    
    the event ID
  - setID
```
public void setID(java.lang.String evtID)
```
    Set the event ID.
    
    Parameters:
    
    evtID - Event ID
  - getSource
```
public java.lang.String getSource()
```
    Return the event source. The identifier of the object that caused this event. For OID generated events, it is the creators/modifiers DN.
    
    Returns:
    
    the event source
  - setSource
```
public void setSource(java.lang.String evtSrc)
```
    Set the event source
    
    Parameters:
    
    evtSrc - Event source
  - getTime
```
public java.lang.String getTime()
```
    Return the event time. The Time of occurrence of the event. This is expected in the UTC format "YYYYMMDDHH24MISSz".
    
    Returns:
    
    the event time
  - setTime
```
public void setTime(java.lang.String evtTime)
```
    Set the event time
    
    Parameters:
    
    evtTime - Event time
  - getObjName
```
public java.lang.String getObjName()
```
    Return the Object name. The Name of the object that changed. For OID events, it is the nickname attribute value.
    
    Returns:
    
    the Object name.
  - setObjName
```
public void setObjName(java.lang.String objName)
```
    Set the Object name.
    
    Parameters:
    
    objName - Object name
  - getObjGuid
```
public java.lang.String getObjGuid()
```
    Return the Object GUID. The Unique ID of the Object that changed. For OID, it is the 32 characters ORCLGUID.
    
    Returns:
    
    the Object GUID
  - setObjGuid
```
public void setObjGuid(java.lang.String objGuid)
```
    Set the Object GUID.
    
    Parameters:
    
    objGuid - Object GUID
  - getObjDN
```
public java.lang.String getObjDN()
```
    Return the Object DN. For OID, it is the DN of the object that changed.
    
    Returns:
    
    the Object DN
  - setObjDN
```
public void setObjDN(java.lang.String objDN)
```
    Set the Object DN
    
    Parameters:
    
    objDN - Object DN
  - getProfileID
```
public java.lang.String getProfileID()
```
    Return the Profile ID. The DIP integration profile ID responsible for this change event. It is of the form <Realm GUID_Application GUID>. If application needs to know which realm a event pertains to, it can use the REALM GUID part of this value.
    
    Returns:
    
    the Profile ID.
  - setProfileID
```
public void setProfileID(java.lang.String profID)
```
    Set the Profile ID
    
    Parameters:
    
    profID - Profile ID
  - getChanges
```
public ModPropertySet getChanges()
```
    Return the changes in the event.
    
    Returns:
    
    A set of changes to be applied.
  - setChanges
```
public void setChanges(ModPropertySet chgs)
```
    Set the changes in the event.
    
    Parameters:
    
    chgs - A set of changes to be applied.
  - addChanges
```
public void addChanges(javax.naming.directory.Attributes attrs)
```
  - getStatus
```
public java.lang.String getStatus()
```
    Returns the status
    
    Returns:
    
    Event Status
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Sets the status
    
    Parameters:
    
    status -
  - size
```
public int size()
```
  - toString
```
public java.lang.String toString()
```
    String representation of the event
    
    Overrides:
    
    toString in class java.lang.Object
  - main
```
public static void main(java.lang.String[] s)
```

Class Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_TYPE_STRING

ATTR_TYPE_BINARY

ATTR_TYPE_ENCRYPTED_STRING

ATTR_TYPE_DATE_STRING

ATTR_TYPE_DECRYPTED_STRING

m_eventType

m_eventID

m_eventSrc

m_eventTime

m_objectName

m_objectGuid

m_objectDN

m_profileID

m_changes

Constructor Detail

Event

Event

Method Detail

getType

setType

getID

setID

getSource

setSource

getTime

setTime

getObjName

setObjName

getObjGuid

setObjGuid

getObjDN

setObjDN

getProfileID

setProfileID

getChanges

setChanges

addChanges

getStatus

setStatus

size

toString

main