org.apache.jackrabbit.webdav.observation

Interface SubscriptionManager

public interface SubscriptionManager

SubscriptionManager interface.

Method Summary

Modifier and Type	Method and Description
SubscriptionDiscovery	getSubscriptionDiscovery(ObservationResource resource) Retrieve the SubscriptionDiscovery object for the given resource.
EventDiscovery	poll(java.lang.String subscriptionId, long timeout, ObservationResource resource) Retrieve the list of events that occurred since the last poll.
Subscription	subscribe(SubscriptionInfo info, java.lang.String subscriptionId, ObservationResource resource) Create a new Subscription or update an existing Subscription..
void	unsubscribe(java.lang.String subscriptionId, ObservationResource resource) Unsubscribe the Subscription with the given id.

Method Detail

getSubscriptionDiscovery

SubscriptionDiscovery getSubscriptionDiscovery(ObservationResource resource)

Retrieve the SubscriptionDiscovery object for the given resource. Note, that the discovery object will be empty if there are no subscriptions present.

Parameters:

resource -

subscribe

Subscription subscribe(SubscriptionInfo info,
                       java.lang.String subscriptionId,
                       ObservationResource resource)
                throws DavException

Create a new Subscription or update an existing Subscription..

Parameters:

info -

subscriptionId -

resource -

Returns:

Subscription that has been created or updated

Throws:

DavException - if the subscription fails

unsubscribe

void unsubscribe(java.lang.String subscriptionId,
                 ObservationResource resource)
          throws DavException

Unsubscribe the Subscription with the given id.

Parameters:

subscriptionId -

resource -

Throws:

DavException

poll

EventDiscovery poll(java.lang.String subscriptionId,
                    long timeout,
                    ObservationResource resource)
             throws DavException

Retrieve the list of events that occurred since the last poll.

Parameters:

subscriptionId - identifier for the subscription

timeout - the time in milliseconds to wait at most for events if none is present currently.

resource -

Returns:

Throws:

DavException