org.jivesoftware.smackx.pubsub

Class Item

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeExtension

org.jivesoftware.smackx.pubsub.Item

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

Direct Known Subclasses:

PayloadItem

public class Item
extends NodeExtension

This class represents an item that has been, or will be published to a PubSub node. An Item has several properties that are dependent on the configuration of the node to which it has been or will be published.

An Item received from a node (via LeafNode.getItems() or Node.addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)

• Will always have an id (either user or server generated) unless node configuration has both ConfigureForm.isPersistItems() and ConfigureForm.isDeliverPayloads()set to false.
• Will have a payload if the node configuration has ConfigureForm.isDeliverPayloads() set to true, otherwise it will be null.

An Item created to send to a node (via LeafNode.publish() or LeafNode.publish()

• The id is optional, since the server will generate one if necessary, but should be used if it is meaningful in the context of the node. This value must be unique within the node that it is sent to, since resending an item with the same id will overwrite the one that already exists if the items are persisted.
• Will require payload if the node configuration has ConfigureForm.isDeliverPayloads() set to true.

To customise the payload object being returned from the PayloadItem.getPayload() method, you can add a custom parser as explained in ItemProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.ItemNamespace

Constructor Summary

Constructors

Constructor and Description
Item() Create an empty Item with no id.
Item(Item.ItemNamespace itemNamespace, String itemId) Create an Item with an id but no payload.
Item(Item.ItemNamespace itemNamespace, String itemId, String nodeId) Create an Item with an id and a node id.
Item(String itemId) Create an Item with an id but no payload.
Item(String itemId, String nodeId) Create an Item with an id and a node id.

Method Summary

Modifier and Type	Method and Description
protected XmlStringBuilder	getCommonXml()
String	getId() Get the item id.
String	toString()
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

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

getElementName, getNamespace, getNode, getPubSubNamespace

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item()

Create an empty Item with no id. This is a valid item for nodes which are configured so that ConfigureForm.isDeliverPayloads() is false. In most cases an id will be generated by the server. For nodes configured with ConfigureForm.isDeliverPayloads() and ConfigureForm.isPersistItems() set to false, no Item is sent to the node, you have to use the LeafNode.publish() method in this case.

Item

public Item(String itemId)

Create an Item with an id but no payload. This is a valid item for nodes which are configured so that ConfigureForm.isDeliverPayloads() is false.

Parameters:

itemId - The id if the item. It must be unique within the node unless overwriting and existing item. Passing null is the equivalent of calling Item().

Item

public Item(Item.ItemNamespace itemNamespace,
            String itemId)

Create an Item with an id but no payload. This is a valid item for nodes which are configured so that ConfigureForm.isDeliverPayloads() is false.

Parameters:

itemId - The id if the item. It must be unique within the node unless overwriting and existing item. Passing null is the equivalent of calling Item().

Item

public Item(String itemId,
            String nodeId)

Create an Item with an id and a node id.

Note: This is not valid for publishing an item to a node, only receiving from one as part of Message. If used to create an Item to publish (via LeafNode.publish(Item), the server may return an error for an invalid packet.

Parameters:

itemId - The id of the item.

nodeId - The id of the node which the item was published to.

Item

public Item(Item.ItemNamespace itemNamespace,
            String itemId,
            String nodeId)

Create an Item with an id and a node id.

Note: This is not valid for publishing an item to a node, only receiving from one as part of Message. If used to create an Item to publish (via LeafNode.publish(Item), the server may return an error for an invalid packet.

Parameters:

itemId - The id of the item.

nodeId - The id of the node which the item was published to.

Method Detail

getId

public String getId()

Get the item id. Unique to the node it is associated with.

Returns:

The id

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.

getCommonXml

protected final XmlStringBuilder getCommonXml()

toString

public String toString()

Overrides:

toString in class NodeExtension