ChangeEvent (Radiant Logic, Inc.)

java.lang.Object
- com.rli.util.identityData.IdentityData
- - com.rli.connectors.changeevent.ChangeEvent

All Implemented Interfaces:: java.lang.Cloneable

public class ChangeEvent
extends IdentityData

A change event represents a single event (an entry that was inserted/updated/deleted/moved) captured on a backend, or an operation (insert/update/delete/move an entry) to apply on a backend.

This class is the essential object used to represent data in a synchronization pipeline. In a synchronization pipeline, the following capture-transform-apply process occurs:
1. An event is detected on a source backend by a capture connector. This is represented as a ChangeEvent object.
2. In the transform phase, the ChangeEvent produced in step 1 is transformed into a new ChangeEvent object that is then sent to the apply connector.
3. The apply connector applies the ChangeEvent object produced in step 2. This results in an operation that is executed on a target backend.

As has been previously described, this class is re-used for 2 different purposes.

- In the context of a capture connector, it represents a single change event captured on a backend by a capture connector. In this scenario, users of this class will mostly be calling the getter methods to fetch existing values from the change event.

- In the context of an apply connector, it is used to represent a change or modification to be applied on a backend, for example to insert, update, or delete an entry on a target naming context. In this scenario, users of this class will mostly be calling the setter methods to build up the set of changes (setting the event ID, attribute values, and the change event type) that will then be applied on the backend.

Key components of a ChangeEvent object:

Every change event has an event ID which can be retrieved using the getEventId method. The event ID must contain the distinguished name (DN) for the entry that was changed or that you want to change.
Every change event has an EventType which indicates the type of change detected (in the capture scenario), or the type of change to be applied on the backend (in the apply scenario).
Every change event has a set of attributes and their corresponding values. The methods to get/set those attributes and values are inherited from the IdentityData class.
A change event has an optional set of patch operations which are used to represent granular updates. For more details, see paragraph below.

Patch Operations:
A change event has an optional set of "patch operations" that are used to represent granular updates. This can be used in 2 scenarios:

By default, events captured by capture connectors contain the entire state (all the attributes and values) of the entry on which a change was detected. In some cases, it can be useful to look only at the actual attributes that were modified. The list of these granular changes can be accessed using the getPatchOperations() method. If this list is not empty, it will contain the granular updates (which attributes were changed, and for each of those attributes which specific values were added or removed or replaced) that were captured on the backend. Note: most connectors do not support granular change detection, see product documentation to find out which capture connectors provide this level of detail.
In the apply connector scenario, you can set the patch operations on the ChangeEvent object in order to perform granular changes. By default, the apply connector replaces the entire set of values for each attribute. You can use patch operations to perform more granular changes such as adding or removing specific values for an attribute instead of replacing the entire set of values. This can be useful in scenarios where replacing the entire set of values for an attribute would be a costly operation (example: replacing 10,000 values for an attribute -vs- adding 10 new values for an attribute).

"Capture" Examples:

Example #1: Extracting the change information and data from an existing ChangeEvent object

 
 // Assume that this change event has been produced by a capture connector.
 ChangeEvent ce;

 // This contains the type of change that was detected: INSERT/UPDATE/DELETE/MOVE
 EventType eventType = ce.getEventType();

 // This contains the event identifier, which is the distinguished name (DN) of the entry that was changed.
 String eventId = ce.getEventId();

 // The set of all the attribute names that have a value.
 Set<String> attributeNames = ce.getAttributeNames();

 // Use this method to check if a change event contains a specific attribute.
 boolean containsTitleAttr = ce.containsAttribute("title");

 // Get the first value of the givenName attribute. Use this method if you know that your attribute is single-valued.
 String valueForGivenName = ce.getFirstValueAsString("givenName");

 // Get the list of values for the mail attribute. Use this method to retrieve all values for a multi-valued attribute.
 List<String> valuesForMail = ce.getValuesAsString("mail");

 // Use this method if you know that your attribute is a single-valued complex attribute.
 ComplexValue complexValueForName = ce.getFirstComplexValue("name");

 // Use this method if you know that your attribute is a multi-valued complex attribute.
 List<ComplexValue> complexValuesForPhoneNumber = ce.getComplexValues("phoneNumbers");

Example #2: Extracting the granular changes (patch operations) from an existing ChangeEvent object

 
  // Assume that this change event has been produced by a capture connector.
  ChangeEvent ce;

  // This method retrieves the list of patch operations (granular changes) that were captured.
  List<IdentityPatchOperation> patchOperations = ce.getPatchOperations();

  // Note: for most capture connector types, this list will be empty. This is because most connectors don't have
  // the ability to capture the granular changes. Check the product documentation to see which connector types
  // support granular change detection.
  if (!patchOperations.isEmpty()) {
     for (IdentityPatchOperation patchOperation : patchOperations) {
        // This tells you the name of the attribute that was modified.
        // Note: this can be a simple attribute like givenName or a complex attribute like name.lastName
        IdentityAttributePath attributePath = patchOperation.getAttributePath();

        // This tells you the type of operation (value added, replaced, or removed) that was detected.
        PatchOpType operationType = patchOperation.getOpType();

        if (patchOperation.isValueComplex()) {
           // This returns the actual data for the complex attribute values that were added/replaced/removed
           List<ComplexValue> complexValues = patchOperation.getComplexValues();
        } else {
           // This returns the actual data for the attribute values that were added/replaced/removed
           List<String> values = patchOperation.getValuesAsString();
        }
    }
 }

"Apply" Examples:

Example #1: Generating a ChangeEvent object to create a new entry on a target naming context or backend

 
 ChangeEvent createEntryOperation = new ChangeEvent(EventType.INSERT);
 // Important: Always set the Event ID, which should be the distinguished name (DN) of the entry you want to insert/update/delete.
 createEntryOperation.setEventId("cn=John Smith,ou=People,o=SuperCorp");
 createEntryOperation.addAttribute("cn", "John Smith");
 createEntryOperation.addAttribute("sn", "Smith");
 createEntryOperation.addAttribute("givenName", "John");
 createEntryOperation.addAttribute("mail", "jsmith@radiantlogic.com", "jsmith@gmail.com");
 createEntryOperation.addAttribute("objectclass", "top", "person", "organizationalPerson", "inetOrgPerson");

Example #2: Generating a ChangeEvent object to update an existing entry on a target naming context or backend

 
 ChangeEvent updateEntryOperation = new ChangeEvent(EventType.UPDATE);
 // Important: Always set the Event ID, which should be the distinguished name of the entry you want to insert/update/delete.
 updateEntryOperation.setEventId("cn=John Smith,ou=People,o=SuperCorp");
 updateEntryOperation.addAttribute("title", "CEO", "Chairman");
 updateEntryOperation.addAttribute("carLicense", "RADIANT");

Example #3: Generating a ChangeEvent object to delete an existing entry on a target naming context or backend

 
 ChangeEvent deleteEntryOperation = new ChangeEvent(EventType.DELETE);
 // Important: Always set the Event ID, which should be the distinguished name of the entry you want to insert/update/delete.
 deleteEntryOperation.setEventId("cn=John Smith,ou=People,o=SuperCorp");

Example #4: Generating a ChangeEvent object to perform an LDAP move operation on a target naming context or backend

 
 ChangeEvent moveEntryOp = new ChangeEvent(EventType.MOVE);
 // The "old dn" should be set to the current distinguished name (DN) of the entry.
 moveEntryOp.setOldDn("cn=jack smith,ou=Sales,o=SuperCorp");
 // Event ID should be set to the new distinguished name (DN) of the entry.
 moveEntryOp.setEventId("uid=jsmith,ou=Marketing,o=SuperCorp");

Example #5: Generate a ChangeEvent object to perform granular updates on an existing entry on a target naming context or backend

 
 ChangeEvent granularUpdateForEntry = new ChangeEvent(EventType.UPDATE);
 granularUpdateForEntry.setEventId("cn=Sales,ou=Groups,o=SuperCorp");
 // Add 2 new members to the group
 granularUpdateForEntry.addPatchOperation(IdentityPatchOperation.add("member", Arrays.asList("cn=Jane Smith,ou=People,o=SuperCorp",
                                                                                             "cn=John Smith,ou=People,o=SuperCorp")));
 // Remove 2 specific members from the group
 granularUpdateForEntry.addPatchOperation(IdentityPatchOperation.remove("member", Arrays.asList("cn=Mike Patterson,ou=People,o=SuperCorp",
                                                                                                "cn=Stephanie Patterson,ou=People,o=SuperCorp")));
 // Replace the description of the group
 granularUpdateForEntry.addPatchOperation(IdentityPatchOperation.replace("description", "What a fun group."));

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeEvent.ChangeEventDeserializer` Implementation of a JsonDeserializer (com.fasterxml.jackson.databind) for ChangeEvent objects.
`static class`	`ChangeEvent.ChangeEventSerializer` Implementation of a JsonSerializer (com.fasterxml.jackson.databind) for ChangeEvent objects.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPROVAL_CONFIG_KEY`
`static java.lang.String`	`APPROVALS_ATTRIBUTE_APPROVERS_LIST`
`static java.lang.String`	`APPROVALS_ATTRIBUTE_STATUS_REJECTED`
`static java.lang.String`	`CHANGE_MODE_KEY` The JSON attribute name for the field which contains the change mode for the ChangeEvent when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`CHG_OPS_KEY` The JSON attribute name for the field which contains all the ChangeEvent patch operations when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`CONNECTOR_CURSOR_KEY` The JSON attribute name for the field which contains the connector cursor for the ChangeEvent when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`CONNECTOR_NAME_KEY` The JSON attribute name for the field which contains the connector identifier for the ChangeEvent when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`EVENT_ID_ATTR_KEY` The JSON attribute name for the field which contains the event identifier for the ChangeEvent when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`EVENT_TYPE_KEY` The JSON attribute name for the field which contains the event type for the ChangeEvent when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`IS_FROM_UPLOAD_KEY` The JSON attribute name for the field which indicates if this ChangeEvent was created during an Upload operation.
`static java.lang.String`	`MESSAGE_ATTRS_KEY` The JSON attribute name for the field which contains all the ChangeEvent attributes and their values when the ChangeEvent is serialized as a JSON object.
`static java.lang.String`	`OLD_DN` The name of the special attribute used for LDAP "move" operations to represent the previous value of the DN (before the move operation is applied).
`static java.lang.String`	`SYNC_EVENT_PIPELINE_ID`

Fields inherited from class com.rli.util.identityData.IdentityData
mapper

Constructor Summary

Constructors
Constructor and Description
`ChangeEvent()` Creates an empty change event object.
`ChangeEvent(EventType eventType)` Creates an empty change event object, initialized with the specified event type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPatchOperation(IdentityPatchOperation patchOperation)` Adds the specified patch operation to the current list of patch operations for this ChangeEvent.
`void`	`addPatchOperations(java.util.List<IdentityPatchOperation> patchOperations)` Adds the specified patch operations to the current list of patch operations for this ChangeEvent.
`void`	`clearPatchOperations()` Removes all patch operations for this ChangeEvent.
`ApprovalConfiguration`	`getApprovalConfiguration()`
`ChangeMode`	`getChangeMode()` Returns the change mode for this ChangeEvent.
`Cursor`	`getConnectorCursor()` Returns the cursor associated with this ChangeEvent.
`java.lang.String`	`getConnectorNameId()` Returns the identifier for the connector that produced this ChangeEvent.
`java.lang.String`	`getEventId()` Returns the event ID for this ChangeEvent.
`EventType`	`getEventType()` Returns the type of event for this ChangeEvent.
`protected java.lang.Object`	`getExtraAttributeValue(java.lang.String attributeName)`
`java.lang.String`	`getOldDn()` Returns the value of the "old_dn" attribute.
`java.util.List<IdentityPatchOperation>`	`getPatchOperations()` Returns the list of patch operations for this ChangeEvent.
`java.util.Map<java.lang.String,java.util.Map<PatchOpType,IdentityPatchOperation>>`	`getPatchOperationsByAttributeMap()` Returns a map, organized by attribute name, representing the current patch operations for this ChangeEvent.
`java.lang.String`	`getSystemExpirationDate()`
`boolean`	`isEmptyPatchOperations()` Indicates whether the list of patch operations for this ChangeEvent is empty.
`boolean`	`isFromUpload()` Represents if this ChangeEvent was created as part of an Upload operation.
`void`	`removePatchOperation(IdentityPatchOperation patchOpToRemove)` Removes the specified patch operation from the current list of patch operations for this ChangeEvent.
`boolean`	`requiresApprovals()`
`void`	`setApprovalConfiguration(ApprovalConfiguration approvalConfiguration)`
`void`	`setChangeMode(ChangeMode changeMode)` Sets the change mode for this ChangeEvent.
`void`	`setConnectorCursor(Cursor connectorCursor)` Sets the capture connector cursor for this ChangeEvent.
`void`	`setConnectorNameId(java.lang.String connectorNameId)` Sets the identifier for the connector that produced this ChangeEvent.
`void`	`setEventId(java.lang.String eventId)` Sets the event ID for this ChangeEvent.
`void`	`setEventType(EventType eventType)` Sets the event type for this ChangeEvent.
`void`	`setFromUpload(boolean isFromUpload)` Sets if this ChangeEvent was created as part of an Upload operation.
`void`	`setOldDn(java.lang.String oldDn)` Sets the value of the "old_dn" attribute.
`void`	`setSystemExpirationDate(java.lang.String systemExpirationDate)`
`java.lang.String`	`toShortString()` Returns a shortened String representation of this ChangeEvent.
`java.lang.String`	`toString()` Returns a String representation of this ChangeEvent.
`java.lang.String`	`toString(boolean isHideValueOfPasswordAttributes)` Returns a String representation of this ChangeEvent.
`java.lang.String`	`toString(boolean isHideValueOfPasswordAttributes, boolean isDetailedCursor)` Returns a String representation of this ChangeEvent.

Methods inherited from class com.rli.util.identityData.IdentityData
addAttribute, addAttribute, addAttribute, addComplexAttribute, addComplexAttribute, addComplexAttribute, clone, containsAttribute, containsComplexAttributeValue, getAdditionalProperties, getAttributeNames, getComplexValues, getFirstComplexValue, getFirstValueAsString, getNullSafeValuesAsString, getValuesAsString, isAttributeValueComplex, listAttributeNames, putAttribute, removeAttribute, renameAttribute, setAdditionalProperty

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

- Field Detail
  - OLD_DN
```
public static final java.lang.String OLD_DN
```
    The name of the special attribute used for LDAP "move" operations to represent the previous value of the DN (before the move operation is applied).
    
    See Also:
    
    Constant Field Values
  - MESSAGE_ATTRS_KEY
```
public static final java.lang.String MESSAGE_ATTRS_KEY
```
    The JSON attribute name for the field which contains all the ChangeEvent attributes and their values when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - CHG_OPS_KEY
```
public static final java.lang.String CHG_OPS_KEY
```
    The JSON attribute name for the field which contains all the ChangeEvent patch operations when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - EVENT_TYPE_KEY
```
public static final java.lang.String EVENT_TYPE_KEY
```
    The JSON attribute name for the field which contains the event type for the ChangeEvent when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - IS_FROM_UPLOAD_KEY
```
public static final java.lang.String IS_FROM_UPLOAD_KEY
```
    The JSON attribute name for the field which indicates if this ChangeEvent was created during an Upload operation.
    
    See Also:
    
    Constant Field Values
  - CONNECTOR_NAME_KEY
```
public static final java.lang.String CONNECTOR_NAME_KEY
```
    The JSON attribute name for the field which contains the connector identifier for the ChangeEvent when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - EVENT_ID_ATTR_KEY
```
public static final java.lang.String EVENT_ID_ATTR_KEY
```
    The JSON attribute name for the field which contains the event identifier for the ChangeEvent when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - CONNECTOR_CURSOR_KEY
```
public static final java.lang.String CONNECTOR_CURSOR_KEY
```
    The JSON attribute name for the field which contains the connector cursor for the ChangeEvent when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - CHANGE_MODE_KEY
```
public static final java.lang.String CHANGE_MODE_KEY
```
    The JSON attribute name for the field which contains the change mode for the ChangeEvent when the ChangeEvent is serialized as a JSON object. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
  - APPROVAL_CONFIG_KEY
```
public static final java.lang.String APPROVAL_CONFIG_KEY
```
    See Also:
    
    Constant Field Values
  - APPROVALS_ATTRIBUTE_STATUS_REJECTED
```
public static final java.lang.String APPROVALS_ATTRIBUTE_STATUS_REJECTED
```
    See Also:
    
    Constant Field Values
  - APPROVALS_ATTRIBUTE_APPROVERS_LIST
```
public static final java.lang.String APPROVALS_ATTRIBUTE_APPROVERS_LIST
```
    See Also:
    
    Constant Field Values
  - SYNC_EVENT_PIPELINE_ID
```
public static final java.lang.String SYNC_EVENT_PIPELINE_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ChangeEvent
```
public ChangeEvent()
```
    Creates an empty change event object.
  - ChangeEvent
```
public ChangeEvent(EventType eventType)
```
    Creates an empty change event object, initialized with the specified event type.
    
    Parameters:
    
    eventType - The event type (INSERT/UPDATE/DELETE/MOVE/SKIP) for the ChangeEvent.
- Method Detail
  - getExtraAttributeValue
```
protected java.lang.Object getExtraAttributeValue(java.lang.String attributeName)
```
    Overrides:
    
    getExtraAttributeValue in class IdentityData
  - isFromUpload
```
public boolean isFromUpload()
```
    Represents if this ChangeEvent was created as part of an Upload operation.
    
    Returns:
    
    true if this ChangeEvent was created as part of an Upload operation.
  - setFromUpload
```
public void setFromUpload(boolean isFromUpload)
```
    Sets if this ChangeEvent was created as part of an Upload operation.
    
    Parameters:
    
    isFromUpload - true if this ChangeEvent was created as part of an Upload operation.
  - getOldDn
```
public java.lang.String getOldDn()
```
    Returns the value of the "old_dn" attribute. The "old_dn" attribute is used in LDAP MOVE operations to represent the previous value of the DN (before the move operation is applied).
    
    Returns:
    
    The value of the "old_dn" attribute.
  - setOldDn
```
public void setOldDn(java.lang.String oldDn)
```
    Sets the value of the "old_dn" attribute. The "old_dn" attribute is used in LDAP MOVE operations to represent the previous value of the DN (before the move operation is applied).
    
    Parameters:
    
    oldDn - The value to set for the "old_dn" attribute.
  - getEventType
```
public EventType getEventType()
```
    Returns the type of event for this ChangeEvent.
    
    Returns:
    
    The type of event for this ChangeEvent.
  - setEventType
```
public void setEventType(EventType eventType)
```
    Sets the event type for this ChangeEvent.
    
    Parameters:
    
    eventType - The event type to set for this ChangeEvent.
  - getEventId
```
public java.lang.String getEventId()
```
    Returns the event ID for this ChangeEvent. The event ID should contain the distinguished name (DN) of the entry.
    
    Returns:
    
    The event ID for this ChangeEvent.
  - setEventId
```
public void setEventId(java.lang.String eventId)
```
    Sets the event ID for this ChangeEvent. The event ID should contain the distinguished name (DN) of the entry.
    
    Parameters:
    
    eventId - The event ID (distinguished name) to set for this ChangeEvent.
  - getConnectorCursor
```
public Cursor getConnectorCursor()
```
    Returns the cursor associated with this ChangeEvent. Connector cursors are usually set automatically by a capture connector. The cursor type and value varies depending on the type of capture connector, but is generally used to keep a reference or pointer to a specific changed entry in a list of changes. Note: this field is reserved for usage by capture connectors.
    
    Returns:
    
    The cursor associated with this ChangeEvent.
  - setConnectorCursor
```
public void setConnectorCursor(Cursor connectorCursor)
```
    Sets the capture connector cursor for this ChangeEvent. Note: this field is reserved for usage by capture connectors.
    
    Parameters:
    
    connectorCursor - The capture connector cursor to set for this change event.
  - getConnectorNameId
```
public java.lang.String getConnectorNameId()
```
    Returns the identifier for the connector that produced this ChangeEvent. If this ChangeEvent was not generated by a connector, this method will return null.
    
    Returns:
    
    the identifier for the connector that produced this ChangeEvent, or null if this ChangeEvent was not generated by a connector.
  - setConnectorNameId
```
public void setConnectorNameId(java.lang.String connectorNameId)
```
    Sets the identifier for the connector that produced this ChangeEvent.
    
    Parameters:
    
    connectorNameId - The connector that produced this ChangeEvent.
  - getChangeMode
```
public ChangeMode getChangeMode()
```
    Returns the change mode for this ChangeEvent. The change mode is used to control the behavior of the apply connectors when they try to apply this ChangeEvent.
    
    Returns:
    
    The change mode for this ChangeEvent.
  - setChangeMode
```
public void setChangeMode(ChangeMode changeMode)
```
    Sets the change mode for this ChangeEvent. The change mode is used to control the behavior of the apply connectors when they try to apply this ChangeEvent.
    
    Parameters:
    
    changeMode - The change mode for this ChangeEvent.
  - getPatchOperations
```
public java.util.List<IdentityPatchOperation> getPatchOperations()
```
    Returns the list of patch operations for this ChangeEvent. Patch operations are used to represent granular changes on attributes (such as adding/replacing/delete specific value(s)).
    
    Returns:
    
    The list of patch operations for this ChangeEvent.
  - isEmptyPatchOperations
```
public boolean isEmptyPatchOperations()
```
    Indicates whether the list of patch operations for this ChangeEvent is empty.
    
    Returns:
    
    true if the list of patch operations for this ChangeEvent is empty, or false otherwise.
  - requiresApprovals
```
public boolean requiresApprovals()
```
  - getSystemExpirationDate
```
public java.lang.String getSystemExpirationDate()
```
  - setSystemExpirationDate
```
public void setSystemExpirationDate(java.lang.String systemExpirationDate)
```
  - addPatchOperation
```
public void addPatchOperation(IdentityPatchOperation patchOperation)
```
    Adds the specified patch operation to the current list of patch operations for this ChangeEvent. Patch operations are used to represent granular changes on attributes (such as adding/replacing/delete specific value(s)).
    
    Parameters:
    
    patchOperation - The patch operation to add to the list of patch operations for this ChangeEvent.
  - addPatchOperations
```
public void addPatchOperations(java.util.List<IdentityPatchOperation> patchOperations)
```
    Adds the specified patch operations to the current list of patch operations for this ChangeEvent. Patch operations are used to represent granular changes on attributes (such as adding/replacing/delete specific value(s)).
    
    Parameters:
    
    patchOperations - The list of patch operation objects to add to the list of patch operations for this ChangeEvent.
  - removePatchOperation
```
public void removePatchOperation(IdentityPatchOperation patchOpToRemove)
```
    Removes the specified patch operation from the current list of patch operations for this ChangeEvent. Patch operations are used to represent granular changes on attributes (such as adding/replacing/delete specific value(s)).
    
    Parameters:
    
    patchOpToRemove - The patch operation to remove from the current list of patch operations for this ChangeEvent.
  - clearPatchOperations
```
public void clearPatchOperations()
```
    Removes all patch operations for this ChangeEvent. Patch operations are used to represent granular changes on attributes (such as adding/replacing/delete specific value(s)).
  - getPatchOperationsByAttributeMap
```
public java.util.Map<java.lang.String,java.util.Map<PatchOpType,IdentityPatchOperation>> getPatchOperationsByAttributeMap()
```
    Returns a map, organized by attribute name, representing the current patch operations for this ChangeEvent. The key of the map is the name of the attribute. The value of the map is another map that represents all the patch operations associated with the corresponding attribute.
    
    Returns:
    
    A map, organized by attribute name, representing the current patch operations for this ChangeEvent.
  - getApprovalConfiguration
```
public ApprovalConfiguration getApprovalConfiguration()
```
  - setApprovalConfiguration
```
public void setApprovalConfiguration(ApprovalConfiguration approvalConfiguration)
```
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this ChangeEvent.
    
    Overrides:
    
    toString in class IdentityData
    
    Returns:
    
    A String representation of this ChangeEvent.
  - toString
```
public java.lang.String toString(boolean isHideValueOfPasswordAttributes)
```
    Returns a String representation of this ChangeEvent.
    
    Overrides:
    
    toString in class IdentityData
    
    Parameters:
    
    isHideValueOfPasswordAttributes - Indicates whether password attributes should have their value hidden from the returned String.
    
    Returns:
    
    A String representation of this ChangeEvent.
  - toString
```
public java.lang.String toString(boolean isHideValueOfPasswordAttributes,
                                 boolean isDetailedCursor)
```
    Returns a String representation of this ChangeEvent.
    
    Parameters:
    
    isHideValueOfPasswordAttributes - Indicates whether password attributes should have their value hidden from the returned String.
    
    isDetailedCursor - Indicates whether the connector cursor should have its full value included in the returned String.
    
    Returns:
    
    A String representation of this ChangeEvent.
  - toShortString
```
public java.lang.String toShortString()
```
    Returns a shortened String representation of this ChangeEvent.
    
    Returns:
    
    A shortened String representation of this ChangeEvent.

Class ChangeEvent

Nested Class Summary

Field Summary

Fields inherited from class com.rli.util.identityData.IdentityData

Constructor Summary

Method Summary

Methods inherited from class com.rli.util.identityData.IdentityData

Methods inherited from class java.lang.Object

Field Detail

OLD_DN

MESSAGE_ATTRS_KEY

CHG_OPS_KEY

EVENT_TYPE_KEY

IS_FROM_UPLOAD_KEY

CONNECTOR_NAME_KEY

EVENT_ID_ATTR_KEY

CONNECTOR_CURSOR_KEY

CHANGE_MODE_KEY

APPROVAL_CONFIG_KEY

APPROVALS_ATTRIBUTE_STATUS_REJECTED

APPROVALS_ATTRIBUTE_APPROVERS_LIST

SYNC_EVENT_PIPELINE_ID

Constructor Detail

ChangeEvent

ChangeEvent

Method Detail

getExtraAttributeValue

isFromUpload

setFromUpload

getOldDn

setOldDn

getEventType

setEventType

getEventId

setEventId

getConnectorCursor

setConnectorCursor

getConnectorNameId

setConnectorNameId

getChangeMode

setChangeMode

getPatchOperations

isEmptyPatchOperations

requiresApprovals

getSystemExpirationDate

setSystemExpirationDate

addPatchOperation

addPatchOperations

removePatchOperation

clearPatchOperations

getPatchOperationsByAttributeMap

getApprovalConfiguration

setApprovalConfiguration

toString

toString

toString

toShortString