|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.sync.types.ChangeRecord
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ChangeRecord
This class represents the basis for a single change record. This is
effectively a hint that a change happened, and some metadata about the
change. A SyncSource implementation should create instances of this class
based on changes detected in the source endpoint (either from a changelog
table or some other change tracking mechanism). The resync process will also
use instances of this class to identify source entries, which can then be
fetched using the fetchEntry()
method on the SyncSource
extension.
Nested Class Summary | |
---|---|
static class |
ChangeRecord.Builder
This class is used to construct ChangeRecord instances. |
Method Summary | |
---|---|
java.lang.String[] |
getChangedAttributes()
Get the set of changed attributes for this change. |
long |
getChangeNumber()
Get the change number that identifies this particular change. |
long |
getChangeTime()
Get the time at which the change occurred. |
com.unboundid.ldap.sdk.ChangeType |
getChangeType()
Get the change type (ADD/MODIFY/MOD-DN/DELETE). |
CompletionStatus |
getCompletionStatus()
Gets the completion status for this change. |
com.unboundid.ldap.sdk.Entry |
getFullEntry()
Get the full source entry (if it was set on this ChangeRecord when it was created). |
com.unboundid.ldap.sdk.DN |
getIdentifiableInfo()
Get a DN that identifies the entry or record that changed (for example "accountID=123"). |
java.lang.String |
getModifier()
Get the user account name that made the change. |
java.lang.Object |
getProperty(java.lang.Object key)
Get the property value (if one exists) for the given key. |
void |
setCompletionStatus(CompletionStatus status)
This method is used by the Sync Pipe to indicate if the completion status of a synchronization operation. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public long getChangeNumber()
public com.unboundid.ldap.sdk.ChangeType getChangeType()
null
.
public com.unboundid.ldap.sdk.DN getIdentifiableInfo()
public java.lang.String[] getChangedAttributes()
public java.lang.String getModifier()
public long getChangeTime()
public com.unboundid.ldap.sdk.Entry getFullEntry()
null
, but some extensions
may opt to set the entry when the ChangeRecord is constructed in order to
skip the fetchEntry()
phase of processing.
null
if it has not been setpublic java.lang.Object getProperty(java.lang.Object key)
key
- the key for a given property to return
null
if the key is null@InternalUseOnly public void setCompletionStatus(CompletionStatus status)
status
- the completion status for this ChangeRecordpublic CompletionStatus getCompletionStatus()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |