rocks.xmpp.extensions.pubsub.model

Interface Subscription

public interface Subscription

Represents the <subscription/> element, which is used in 'pubsub', 'pubsub#event' and 'pubsub#owner' namespace.

Method Summary

Modifier and Type	Method and Description
Instant	getExpiry() Gets the expiry of the subscription.
rocks.xmpp.addr.Jid	getJid() Gets the subscriber.
String	getNode() Gets the node.
String	getSubId() Gets the subscription id, which is used to differentiate between multiple subscriptions for the same entity.
SubscriptionState	getSubscriptionState() Gets the subscription state to a node.
boolean	isConfigurationRequired() Indicates if subscription configuration is required.
boolean	isConfigurationSupported() Indicates if subscription options are supported (but not necessarily required).

Method Detail

getJid

rocks.xmpp.addr.Jid getJid()

Gets the subscriber.

Returns:

The subscriber.

getNode

String getNode()

Gets the node.

Returns:

The node.

getSubId

String getSubId()

Gets the subscription id, which is used to differentiate between multiple subscriptions for the same entity.

Returns:

The subscription id.

getSubscriptionState

SubscriptionState getSubscriptionState()

Gets the subscription state to a node.

Returns:

The subscription state.

getExpiry

Instant getExpiry()

Gets the expiry of the subscription.

Returns:

The expiry.

See Also:

12.18 Time-Based Subscriptions (Leases)

isConfigurationRequired

boolean isConfigurationRequired()

Indicates if subscription configuration is required.

Returns:

True, if subscription configuration is required.

isConfigurationSupported

boolean isConfigurationSupported()

Indicates if subscription options are supported (but not necessarily required).

Returns:

True, if subscription options are supported (but not necessarily required).