org.jivesoftware.smackx.pubsub

Class Subscription

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeExtension

org.jivesoftware.smackx.pubsub.Subscription

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class Subscription
extends NodeExtension

Represents a subscription to node for both requests and replies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Subscription.State

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	configRequired
protected String	id
protected Jid	jid
protected Subscription.State	state

Constructor Summary

Constructors

Constructor and Description
Subscription(Jid subscriptionJid) Used to constructs a subscription request to the root node with the specified JID.
Subscription(Jid subscriptionJid, String nodeId) Used to constructs a subscription request to the specified node with the specified JID.
Subscription(Jid jid, String nodeId, String subscriptionId, Subscription.State state) Constructs a representation of a subscription reply to the specified node and JID.
Subscription(Jid jid, String nodeId, 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

Modifier and Type	Method and Description
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 the getState() is Subscription.State.unconfigured.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class org.jivesoftware.smackx.pubsub.NodeExtension

getElementName, getNamespace, getNode, getPubSubNamespace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

jid

protected Jid jid

id

protected 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,
                    String nodeId)

Used to constructs a subscription request to the specified node with the specified JID.

Parameters:

subscriptionJid - The subscriber JID

nodeId - The node id

Subscription

public Subscription(Jid subscriptionJid,
                    Subscription.State state)

Construct a subscription change request to the specified state.

Parameters:

subscriptionJid - The subscriber JID

state - The requested new state

Subscription

public Subscription(Jid jid,
                    String nodeId,
                    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 under

nodeId - The node subscribed to

subscriptionId - The id of this subscription

state - The current state of the subscription

Subscription

public Subscription(Jid jid,
                    String nodeId,
                    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 under

nodeId - The node subscribed to

subscriptionId - The id of this subscription

state - The current state of the subscription

configRequired - Is configuration required to complete the subscription

Method Detail

getJid

public Jid getJid()

Gets the JID the subscription is created for.

Returns:

The JID

getId

public 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 the getState() is Subscription.State.unconfigured.

Returns:

true if configuration is required, false otherwise

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Overrides:

toXML in class NodeExtension

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.