org.glassfish.cafe.api.presence
Interface WatcherInfo

public interface WatcherInfo

Watcher Info entity represents the information of a Watcher.

Nested Class Summary

static class	WatcherInfo.Event
static class	WatcherInfo.Status

Method Summary

void	addUserToBlackList() Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.
void	addUserToWhiteList() Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.
String	getDisplayName() Returns the display name of the watcher.
WatcherInfo.Event	getEvent() Returns the event that caused the subscription to change status.
WatcherInfo.Status	getStatus() Returns the status of the watcher subscription.
String	getUserId() Returns the URI of the watcher that is subscribing to the resource.

Method Detail

getDisplayName

String getDisplayName()

Returns the display name of the watcher.

Returns:

the display name or null if there is no display name for the watcher

getUserId

String getUserId()

Returns the URI of the watcher that is subscribing to the resource.

Returns:

the URI of the watcher.

getStatus

WatcherInfo.Status getStatus()

Returns the status of the watcher subscription.

Returns:

the status of the subscription.

getEvent

WatcherInfo.Event getEvent()

Returns the event that caused the subscription to change status.

Returns:

the event that caused the status change.

addUserToWhiteList

void addUserToWhiteList()

Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.

Throws:

IllegalStateException - when the Status of the watcherinfo is not PENDING

addUserToBlackList

void addUserToBlackList()

Arranges the watcher to be added, by administrative means, to the white list of the WatcherInfoSubscriber.

Throws:

IllegalStateException - when the Status of the watcherinfo is not PENDING