org.apache.jackrabbit.webdav.observation

Interface Subscription

All Superinterfaces:

XmlSerializable

All Known Implementing Classes:

SubscriptionImpl

public interface Subscription
extends XmlSerializable

Subscription represents public representation of the event listener created (or modified) by a successful SUBSCRIBE request.
Please note that this interface extends the XmlSerializable interface. The Xml representation of a Subscription is returned in the response to a successful SUBSCRIBE request as well as in a PROPFIND request. In both cases the subscription is packed into a SubscriptionDiscovery property object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	eventsProvideNodeTypeInformation()
boolean	eventsProvideNoLocalFlag()
String	getSubscriptionId() Returns the id of this subscription, that must be used for un-subscribing as well as for event discovery later on.

Methods inherited from interface org.apache.jackrabbit.webdav.xml.XmlSerializable

toXml

Method Detail

getSubscriptionId

String getSubscriptionId()

Returns the id of this subscription, that must be used for un-subscribing as well as for event discovery later on.

Returns:

subscriptionId

eventsProvideNodeTypeInformation

boolean eventsProvideNodeTypeInformation()

Returns:

whether events will be returned with node type information

eventsProvideNoLocalFlag

boolean eventsProvideNoLocalFlag()

Returns:

whether events will be returned with the "noLocal" flag