org.jivesoftware.smackx.pubsub.packet

Class PubSub

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.pubsub.packet.PubSub

public class PubSub
extends IQ

The standard PubSub extension of an IQ packet. This is the topmost element of all pubsub requests and replies as defined in the Publish-Subscribe specification.

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
PubSub()
PubSub(String to, IQ.Type type)
PubSub(String to, IQ.Type type, PubSubNamespace ns)

Method Summary

Methods

Modifier and Type	Method and Description
static PubSub	createPubsubPacket(String to, IQ.Type type, PacketExtension extension, PubSubNamespace ns)
String	getChildElementXML() Returns the XML representation of a pubsub element according the specification.
String	getElementName() Returns the XML element name of the extension sub-packet root element.
PacketExtension	getExtension(PubSubElementType elem)
String	getNamespace() Returns the XML namespace of the extension sub-packet root element.
PubSubNamespace	getPubSubNamespace() Returns the current value of the namespace.
void	setPubSubNamespace(PubSubNamespace ns) Set the namespace for the packet if it something other than the default case of PubSubNamespace.BASIC.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

PubSub

public PubSub()

PubSub

public PubSub(String to,
      IQ.Type type)

PubSub

public PubSub(String to,
      IQ.Type type,
      PubSubNamespace ns)

Method Detail

getElementName

public String getElementName()

Returns the XML element name of the extension sub-packet root element.

Returns:

the XML element name of the packet extension.

getNamespace

public String getNamespace()

Returns the XML namespace of the extension sub-packet root element. According the specification the namespace is http://jabber.org/protocol/pubsub with a specific fragment depending on the request. The namespace is defined at XMPP Registrar at The default value has no fragment.

Returns:

the XML namespace of the packet extension.

setPubSubNamespace

public void setPubSubNamespace(PubSubNamespace ns)

Set the namespace for the packet if it something other than the default case of PubSubNamespace.BASIC. The getNamespace() method will return the result of calling PubSubNamespace.getXmlns() on the specified enum.

Parameters:

ns - - The new value for the namespace.

getExtension

public PacketExtension getExtension(PubSubElementType elem)

getPubSubNamespace

public PubSubNamespace getPubSubNamespace()

Returns the current value of the namespace. The getNamespace() method will return the result of calling PubSubNamespace.getXmlns() this value.

Returns:

The current value of the namespace.

getChildElementXML

public String getChildElementXML()

Returns the XML representation of a pubsub element according the specification. The XML representation will be inside of an iq packet like in the following example:

 <iq type='set' id="MlIpV-4" to="pubsub.gato.home" from="gato3@gato.home/Smack">
     <pubsub xmlns="http://jabber.org/protocol/pubsub">
                      :
         Specific request extension
                      :
     </pubsub>
 </iq>
 

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.

createPubsubPacket

public static PubSub createPubsubPacket(String to,
                        IQ.Type type,
                        PacketExtension extension,
                        PubSubNamespace ns)