org.identityconnectors.framework.common.objects

Interface Subscription

All Superinterfaces:

AutoCloseable, Closeable

public interface Subscription
extends Closeable

A SubscriptionHandler represents a subscription to an asynchronous event channel.

Since:

1.5

Method Summary

Modifier and Type	Method and Description
void	close() Unsubscribes this SubscriptionHandler from receiving messages sent to this channel.
Object	getReturnValue() Get the return value associated with establishing this subscription.
boolean	isUnsubscribed() Indicates whether this Subscription is currently unsubscribed.

Method Detail

close

void close()

Unsubscribes this SubscriptionHandler from receiving messages sent to this channel.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

See Also:

ConnectorEventSubscriptionApiOp.subscribe(ObjectClass, Filter, Observer, OperationOptions), SyncEventSubscriptionApiOp.subscribe(ObjectClass, SyncToken, Observer, OperationOptions)

isUnsubscribed

boolean isUnsubscribed()

Indicates whether this Subscription is currently unsubscribed.

Returns:

true if this Subscription is currently unsubscribed, false otherwise

getReturnValue

Object getReturnValue()

Get the return value associated with establishing this subscription.

Returns:

return value