org.glassfish.cafe.api.presence
Interface WatcherInfoSubscriberFilter

public interface WatcherInfoSubscriberFilter

A watcher info filter enables the possibility to set filters and limit the data received in the ImsWatcherInfoDocument. This example demonstrates how to create two filters and make a subscription.

 // create a filter
 WatcherInfoSubscriberFilter filter = watcherInfoSubscriber.createFilter();
 // include some nodes in the filter
 filter.includePendingWatchers();
 filter.includeActiveWatchers();
 ..
 watcherInfoSubscriber.update();
 

Method Summary

void	addElement(Element element) Adds Element to your filter
Element	getElementNS(String uri, String name) Returns an Element object belonging to this filter Document
NodeList	getElementsNS(String uri, String name) Returns an Element object belonging to this filter Document
String	getXML() Returns the raw XML content of this filter
void	includeActiveWatchers() Includes a filter for active watchers
void	includePendingWatchers() Includes a filter for pending watchers.
void	includeTerminatedWatchers() Includes a filter for terminated watchers.
void	includeWaitingWatchers() Includes a filter for waiting watchers.

Method Detail

includeActiveWatchers

void includeActiveWatchers()

Includes a filter for active watchers

includePendingWatchers

void includePendingWatchers()

Includes a filter for pending watchers.

includeTerminatedWatchers

void includeTerminatedWatchers()

Includes a filter for terminated watchers.

includeWaitingWatchers

void includeWaitingWatchers()

Includes a filter for waiting watchers.

getXML

String getXML()

Returns the raw XML content of this filter

Returns:

the XML String representing the filter document.

addElement

void addElement(Element element)

Adds Element to your filter

getElementNS

Element getElementNS(String uri,
                     String name)

Returns an Element object belonging to this filter Document

getElementsNS

NodeList getElementsNS(String uri,
                       String name)

Returns an Element object belonging to this filter Document