org.jivesoftware.smackx.pubsub
Class PayloadItem<E extends PacketExtension>

java.lang.Object
  org.jivesoftware.smackx.pubsub.NodeExtension
      org.jivesoftware.smackx.pubsub.Item
          org.jivesoftware.smackx.pubsub.PayloadItem<E>

All Implemented Interfaces:

PacketExtension

public class PayloadItem<E extends PacketExtension>
extends Item

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.send() 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 getPayload() method, you can add a custom parser as explained in ItemProvider.

Author:

Robin Collier

Constructor Summary

PayloadItem(E payloadExt)
Create an Item with no id and a payload The id will be set by the server.

PayloadItem(String itemId, E payloadExt)
Create an Item with an id and payload.

PayloadItem(String itemId, String nodeId, E payloadExt)
Create an Item with an id, node id and payload.

Method Summary

E	getPayload() Get the payload associated with this Item.
String	toString()
String	toXML() Returns the XML representation of the PacketExtension.

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

getId, getNamespace

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

getElementName, getNode

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadItem

public PayloadItem(E payloadExt)

Create an Item with no id and a payload The id will be set by the server.

Parameters:

payloadExt - A PacketExtension which represents the payload data.

PayloadItem

public PayloadItem(String itemId,
                   E payloadExt)

Create an Item with an id and payload.

Parameters:

itemId - The id of this item. It can be null if we want the server to set the id.

payloadExt - A PacketExtension which represents the payload data.

PayloadItem

public PayloadItem(String itemId,
                   String nodeId,
                   E payloadExt)

Create an Item with an id, node id and payload.

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 this item.

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

payloadExt - A PacketExtension which represents the payload data.

Method Detail

getPayload

public E getPayload()

Get the payload associated with this Item. Customising the payload parsing from the server can be accomplished as described in ItemProvider.

Returns:

The payload as a PacketExtension.

toXML

public String toXML()

Description copied from interface: PacketExtension

Returns the XML representation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Overrides:

toXML in class Item

Returns:

the packet extension as XML.

toString

public String toString()

Overrides:

toString in class Item