org.glassfish.cafe.api.presence
Interface PeerPresentity

public interface PeerPresentity

A logical entity that has Presence Information (see definition below) associated with it. A Presentity is most commonly a reference for a person, although it may represent a role such as "help desk" or a resource such as "conference room #27". The presentity is identified by a SIP URI (as defined in RFC3261],

Nested Class Summary

static class

PeerPresentity.SubscriptionState The subscription state according to RFC3265.

Method Summary

String	getIdentity() Returns the identity associated to this Peer Presentity
PresenceDocument	getPresenceDocument() Returns the associated presence container
PeerPresentity.SubscriptionState	getSubscriptionState() Returns the subscription state of the peer presentity.
String	getTerminationReason() Returns the reason why the subscription state is TERMINATED.

Method Detail

getPresenceDocument

PresenceDocument getPresenceDocument()

Returns the associated presence container

getIdentity

String getIdentity()

Returns the identity associated to this Peer Presentity

getSubscriptionState

PeerPresentity.SubscriptionState getSubscriptionState()

Returns the subscription state of the peer presentity.

getTerminationReason

String getTerminationReason()

Returns the reason why the subscription state is TERMINATED. Equals "Subscription-State" header field in RFC 3265.

Returns:

string containing the reason.

Throws:

IllegalStateException - if the subscription state is not TERMINATED.