Package org.jivesoftware.smackx.pubsub
Class Subscription
- java.lang.Object
-
- org.jivesoftware.smackx.pubsub.NodeExtension
-
- org.jivesoftware.smackx.pubsub.Subscription
-
- All Implemented Interfaces:
Element
,ExtensionElement
,FullyQualifiedElement
,NamedElement
,XmlLangElement
public class Subscription extends NodeExtension
Represents a subscription to node for both requests and replies.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Subscription.State
-
Field Summary
Fields Modifier and Type Field Description protected boolean
configRequired
protected java.lang.String
id
protected Jid
jid
protected Subscription.State
state
-
Constructor Summary
Constructors Constructor Description Subscription(Jid subscriptionJid)
Used to constructs a subscription request to the root node with the specified JID.Subscription(Jid subscriptionJid, java.lang.String nodeId)
Used to constructs a subscription request to the specified node with the specified JID.Subscription(Jid jid, java.lang.String nodeId, java.lang.String subscriptionId, Subscription.State state)
Constructs a representation of a subscription reply to the specified node and JID.Subscription(Jid jid, java.lang.String nodeId, java.lang.String subscriptionId, Subscription.State state, boolean configRequired)
Constructs a representation of a subscription reply to the specified node and JID.Subscription(Jid subscriptionJid, Subscription.State state)
Construct a subscription change request to the specified state.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addXml(XmlStringBuilder xml)
java.lang.String
getId()
Gets the subscription id.Jid
getJid()
Gets the JID the subscription is created for.Subscription.State
getState()
Gets the current subscription state.boolean
isConfigRequired()
This value is only relevant when thegetState()
isSubscription.State.unconfigured
.-
Methods inherited from class org.jivesoftware.smackx.pubsub.NodeExtension
getElementName, getNamespace, getNode, getPubSubNamespace, toString, toXML
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement
getLanguage, getQName
-
-
-
-
Field Detail
-
id
protected java.lang.String id
-
state
protected Subscription.State state
-
configRequired
protected boolean configRequired
-
-
Constructor Detail
-
Subscription
public Subscription(Jid subscriptionJid)
Used to constructs a subscription request to the root node with the specified JID.- Parameters:
subscriptionJid
- The subscriber JID
-
Subscription
public Subscription(Jid subscriptionJid, java.lang.String nodeId)
Used to constructs a subscription request to the specified node with the specified JID.- Parameters:
subscriptionJid
- The subscriber JIDnodeId
- The node id
-
Subscription
public Subscription(Jid subscriptionJid, Subscription.State state)
Construct a subscription change request to the specified state.- Parameters:
subscriptionJid
- The subscriber JIDstate
- The requested new state
-
Subscription
public Subscription(Jid jid, java.lang.String nodeId, java.lang.String subscriptionId, Subscription.State state)
Constructs a representation of a subscription reply to the specified node and JID. The server will have supplied the subscription id and current state.- Parameters:
jid
- The JID the request was made undernodeId
- The node subscribed tosubscriptionId
- The id of this subscriptionstate
- The current state of the subscription
-
Subscription
public Subscription(Jid jid, java.lang.String nodeId, java.lang.String subscriptionId, Subscription.State state, boolean configRequired)
Constructs a representation of a subscription reply to the specified node and JID. The server will have supplied the subscription id and current state and whether the subscription need to be configured.- Parameters:
jid
- The JID the request was made undernodeId
- The node subscribed tosubscriptionId
- The id of this subscriptionstate
- The current state of the subscriptionconfigRequired
- Is configuration required to complete the subscription
-
-
Method Detail
-
getId
public java.lang.String getId()
Gets the subscription id.- Returns:
- The subscription id
-
getState
public Subscription.State getState()
Gets the current subscription state.- Returns:
- Current subscription state
-
isConfigRequired
public boolean isConfigRequired()
This value is only relevant when thegetState()
isSubscription.State.unconfigured
.- Returns:
- true if configuration is required, false otherwise
-
addXml
protected void addXml(XmlStringBuilder xml)
- Overrides:
addXml
in classNodeExtension
-
-