org.identityconnectors.framework.common.objects

Interface SyncResultsHandler

All Known Subinterfaces:

SyncTokenResultsHandler

All Known Implementing Classes:

NormalizingSyncResultsHandler, SyncImpl.AttributesToGetSyncResultsHandler

public interface SyncResultsHandler

Callback interface that an application implements in order to handle results from SyncApiOp in a stream-processing fashion.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	handle(SyncDelta delta) Called to handle a delta in the stream.

Method Detail

handle

boolean handle(SyncDelta delta)

Called to handle a delta in the stream. The Connector framework will call this method multiple times, once for each result. Although this method is callback, the framework will invoke it synchronously. Thus, the framework guarantees that once an application's call to SyncApiOp#sync() returns, the framework will no longer call this method to handle results from that sync() operation.

Parameters:

delta - The change

Returns:

True if the application wants to continue processing more results.

Throws:

RuntimeException - If the application encounters an exception. This will stop iteration and the exception will propagate to the application.