org.jivesoftware.smackx.pubsub.packet

Class PubSub

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.pubsub.packet.PubSub

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

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.IQChildElementXmlStringBuilder, 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.IQ

IQ_ELEMENT, QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PubSub	createPubsubPacket(String to, IQ.Type type, ExtensionElement extension, PubSubNamespace ns)
String	getElementName() Returns the XML element name of the extension sub-packet root element.
<PE extends ExtensionElement> PE	getExtension(PubSubElementType elem)
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) Returns the XML representation of a pubsub element according the specification.

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

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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(PubSubNamespace ns)

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 stanza(/packet) extension.

getExtension

public <PE extends ExtensionElement> PE getExtension(PubSubElementType elem)

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Returns the XML representation of a pubsub element according the specification. The XML representation will be inside of an iq stanza(/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:

getIQChildElementBuilder in class IQ

Parameters:

xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.

createPubsubPacket

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