Interface SubscriptionManager
public interface SubscriptionManager
SubscriptionManager interface.-
Method Summary
Modifier and TypeMethodDescriptiongetSubscriptionDiscovery(ObservationResource resource) Retrieve theSubscriptionDiscoveryobject for the given resource.poll(String subscriptionId, long timeout, ObservationResource resource) Retrieve the list of events that occurred since the last poll.subscribe(SubscriptionInfo info, String subscriptionId, ObservationResource resource) Create a newSubscriptionor update an existingSubscription..voidunsubscribe(String subscriptionId, ObservationResource resource) Unsubscribe theSubscriptionwith the given id.
-
Method Details
-
getSubscriptionDiscovery
Retrieve theSubscriptionDiscoveryobject 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, String subscriptionId, ObservationResource resource) throws DavException Create a newSubscriptionor update an existingSubscription..- Parameters:
info-subscriptionId-resource-- Returns:
Subscriptionthat has been created or updated- Throws:
DavException- if the subscription fails
-
unsubscribe
Unsubscribe theSubscriptionwith the given id.- Parameters:
subscriptionId-resource-- Throws:
DavException
-
poll
EventDiscovery poll(String subscriptionId, long timeout, ObservationResource resource) throws DavException Retrieve the list of events that occurred since the last poll.- Parameters:
subscriptionId- identifier for the subscriptiontimeout- the time in milliseconds to wait at most for events if none is present currently.resource-- Returns:
- Throws:
DavException
-