org.identityconnectors.framework.api.operations

Interface SyncEventSubscriptionApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

AsyncConnectorFacade, ConnectorFacade

All Known Implementing Classes:

AbstractConnectorFacade, LocalConnectorFacadeImpl, RemoteAsyncConnectorFacade, RemoteConnectorFacadeImpl, SubscriptionImpl.SyncEventSubscriptionApiOpImpl, SyncEventSubscriptionApiOpImpl

public interface SyncEventSubscriptionApiOp
extends APIOperation

Since:

1.5

Field Summary

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

NO_TIMEOUT

Method Summary

Modifier and Type	Method and Description
Subscription	subscribe(ObjectClass objectClass, SyncToken token, Observer<SyncDelta> handler, OperationOptions operationOptions) Create a subscription to a given sync topic.

Method Detail

subscribe

Subscription subscribe(ObjectClass objectClass,
                       SyncToken token,
                       Observer<SyncDelta> handler,
                       OperationOptions operationOptions)

Create a subscription to a given sync topic.

Parameters:

objectClass -

handler - the Observer that will handle emissions and notifications from the Observable

operationOptions -

Returns:

a Subscription reference with which the Observer can stop receiving items before the Observable has completed

Throws:

RuntimeException - when the operation failed to create subscription.