Interface Subscription
-
- All Superinterfaces:
Addressable
public interface Subscription extends Addressable
Represents the<subscription/>
element, which is used in 'pubsub', 'pubsub#event' and 'pubsub#owner' namespace.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Instant
getExpiry()
Gets the expiry of the subscription.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
Jid getJid()
Gets the subscriber.- Specified by:
getJid
in interfaceAddressable
- 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).
-
-