public interface SyncApiOp extends APIOperation
Connectors that implement the SyncOp SPI will support this.
SyncOp
NO_TIMEOUT
Modifier and Type | Method and Description |
---|---|
SyncToken |
getLatestSyncToken(ObjectClass objectClass)
Returns the token corresponding to the most recent synchronization event
for any instance of the specified object class.
|
SyncToken |
sync(ObjectClass objectClass,
SyncToken token,
SyncResultsHandler handler,
OperationOptions options)
Request synchronization events--i.e., native changes to target objects.
|
SyncToken sync(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)
This method will call the specified handler once to pass back each matching synchronization event. Once this method returns, this method will no longer invoke the specified handler.
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 sync()
method and then pass that token into
that client's next call to this sync()
method. 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 sync()
method. 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" can
call getLatestSyncToken(org.identityconnectors.framework.common.objects.ObjectClass)
and then pass that token into this
sync()
method.
objectClass
- 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 SyncResultsHandler
will return any number of
SyncDelta objects, each of which contains a
token. Should be null
if 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.null
.IllegalArgumentException
- if objectClass
or handler
is null or if any
argument is invalid.SyncToken getLatestSyncToken(ObjectClass objectClass)
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.
objectClass
- the class of object for which to find the most recent
synchronization event (if any).null
.Copyright © 2019. All rights reserved.