org.apache.jackrabbit.webdav.observation

Interface ObservationResource

All Superinterfaces:

DavResource

All Known Implementing Classes:

DefaultItemCollection, DefaultItemResource, VersionControlledItemCollection, VersionHistoryItemCollection, VersionItemCollection

public interface ObservationResource
extends DavResource

ObservationResource extends the DavResource interface by observation relevant METHODS.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHODS

Method Summary

Modifier and Type	Method and Description
void	init(SubscriptionManager subsMgr) Initializes this resource.
EventDiscovery	poll(String subscriptionId, long timeout) Retrieve the list of events that where recorded for the event listener with the given SubscriptionId.
Subscription	subscribe(SubscriptionInfo info, String subscriptionId) Subscribe this resource for event listening defined by the specified subscription info.
void	unsubscribe(String subscriptionId) Unsubscribe the event listener with the given SubscriptionId.

Methods inherited from interface org.apache.jackrabbit.webdav.DavResource

addLockManager, addMember, alterProperties, copy, exists, getCollection, getComplianceClass, getDisplayName, getFactory, getHref, getLocator, getLock, getLocks, getMembers, getModificationTime, getProperties, getProperty, getPropertyNames, getResourcePath, getSession, getSupportedMethods, hasLock, isCollection, isLockable, lock, move, refreshLock, removeMember, removeProperty, setProperty, spool, unlock

Field Detail

METHODS

static final String METHODS

See Also:

Constant Field Values

Method Detail

init

void init(SubscriptionManager subsMgr)

Initializes this resource.

Parameters:

subsMgr - subscription manager object

subscribe

Subscription subscribe(SubscriptionInfo info,
                       String subscriptionId)
                throws DavException

Subscribe this resource for event listening defined by the specified subscription info. A subscriptionId may be specified in case an existing subscription should be modified.

Parameters:

info - SubscriptionInfo object as defined by the request body and headers.

subscriptionId - or null if the SubscriptionId header is missing.

Returns:

Subscription object in case the subscription was successful.

Throws:

DavException

unsubscribe

void unsubscribe(String subscriptionId)
          throws DavException

Unsubscribe the event listener with the given SubscriptionId.

Parameters:

subscriptionId - as present in the SubscriptionId header.

Throws:

DavException

poll

EventDiscovery poll(String subscriptionId,
                    long timeout)
             throws DavException

Retrieve the list of events that where recorded for the event listener with the given SubscriptionId.

Parameters:

subscriptionId - as present in the SubscriptionId header.

timeout - as present in the ObservationConstants.HEADER_POLL_TIMEOUT header or 0 (zero) if none is present.

Returns:

EventDiscovery object

Throws:

DavException