Package org.identityconnectors.framework.api.operations

Interface LiveSyncApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface LiveSyncApiOp
extends APIOperation

Poll for synchronization events--i.e., native changes to target objects.

Connectors that implement the LiveSyncOp SPI will support this.

See Also:

LiveSyncOp

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Method Summary

Modifier and Type	Method	Description
void	livesync(ObjectClass objectClass, LiveSyncResultsHandler handler, OperationOptions options)	Request synchronization events--i.e., native changes to target objects.

Method Detail

livesync

void livesync(ObjectClass objectClass,
              LiveSyncResultsHandler handler,
              OperationOptions options)

Request synchronization events--i.e., native changes to target objects.

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.

Parameters:

objectClass - The class of object for which to return synchronization events. Must not be null.

handler - The result handler. Must not be null.

options - Options that affect the way this operation is run. May be null.

Throws:

IllegalArgumentException - if objectClass or handler is null or if any argument is invalid.