public interface SyncApiOp extends APIOperation
Connectors that implement the SyncOp SPI will support this.
|Modifier and Type||Method and Description|
Returns the token corresponding to the most recent synchronization event for any instance of the specified object class.
Request synchronization events--i.e., native changes to target objects.
void sync(ObjectClass objClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)
Each synchronization event contains a token
that can be used to resume reading events starting from that point in the event stream.
In typical usage, a client will save the token from the final synchronization event
that was received from one invocation of this
and then pass that token into that client's next call to this
This allows a client to "pick up where he left off" in receiving synchronization events.
However, a client can pass the token from any synchronization event
into a subsequent invocation of this
This will return synchronization events (that represent native changes that
occurred) immediately subsequent to the event from which the client obtained the token.
A client that wants to read synchronization events "starting now"
getLatestSyncToken(org.identityconnectors.framework.common.objects.ObjectClass) and then pass that token
objClass- The class of object for which to return synchronization events. Must not be null.
token- The token representing the last token from the previous sync. The
SyncResultsHandlerwill return any number of SyncDelta objects, each of which contains a token. Should be
nullif this is the client's first call to the
sync()method for this connector.
handler- The result handler. Must not be null.
options- Options that affect the way this operation is run. May be null.
handleris null or if any argument is invalid.
SyncToken getLatestSyncToken(ObjectClass objClass)
An application that wants to receive synchronization events "starting now" --i.e., wants to receive only native changes that occur after this method is called-- should call this method and then pass the resulting token into the sync() method.
objClass- the class of object for which to find the most recent synchronization event (if any).
Copyright © 2013. All Rights Reserved.