rocks.xmpp.extensions.pubsub

Class PubSubNode

java.lang.Object

rocks.xmpp.extensions.pubsub.PubSubNode

public final class PubSubNode
extends Object

Author:

Christian Schudt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubNode.Type The node type.

Method Summary

Modifier and Type	Method and Description
String	create() Creates a node.
String	create(rocks.xmpp.extensions.data.model.DataForm dataForm) Creates and configures this node.
void	delete() Deletes a node on the pubsub service.
void	delete(URI uri) Deletes this node and specifies a replacement node.
List<Item>	discoverItems() Gets the items for this node.
List<Affiliation>	getAffiliations() Gets the affiliations for this node.
rocks.xmpp.extensions.data.model.DataForm	getDefaultSubscriptionOptions() Gets the default subscription options for a specific node.
String	getId() Gets the node id.
List<Item>	getItems() Gets all items for this node.
List<Item>	getItems(int maxItems) Gets the most recent items.
List<Item>	getItems(String... ids) Gets one or more items with a given item id for a specific node.
String	getName() Gets the name.
rocks.xmpp.extensions.data.model.DataForm	getNodeConfiguration() Gets the node configuration form.
NodeInfo	getNodeInfo() Gets node info.
List<PubSubNode>	getNodes() Gets the (sub-)nodes, which hierarchically reside under this node, e.g. the "second-level" nodes.
rocks.xmpp.extensions.data.model.DataForm	getSubscriptionOptions() Requests the subscription options for this node.
List<Subscription>	getSubscriptions() Gets the subscriptions for this node.
PubSubNode.Type	getType() Gets the type of this node.
String	publish(Object item) Publishes an item to this node.
String	publish(String id, Object item) Publishes an item to this node.
void	purge() Purges this node of all published items.
void	submitNodeConfiguration(rocks.xmpp.extensions.data.model.DataForm dataForm) Submits the node configuration form.
void	submitSubscriptionOptions(rocks.xmpp.extensions.data.model.DataForm dataForm) Submits subscription options for this node.
Subscription	subscribe() Subscribes to this node.
Subscription	subscribe(rocks.xmpp.extensions.data.model.DataForm dataForm) Subscribes to and configures this node.
String	toString()
void	unsubscribe() Unsubscribes from this node.
void	unsubscribe(String subscriptionId) Unsubscribes from this node.

Methods inherited from class java.lang.Object

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

Method Detail

getNodeInfo

public NodeInfo getNodeInfo()
                     throws rocks.xmpp.core.XmppException

Gets node info.

Returns:

The node info.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

discoverItems

public List<Item> discoverItems()
                         throws rocks.xmpp.core.XmppException

Gets the items for this node.

Returns:

The items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

5.5 Discover Items for a Node

getSubscriptions

public List<Subscription> getSubscriptions()
                                    throws rocks.xmpp.core.XmppException

Gets the subscriptions for this node.

Returns:

The subscriptions for the node.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

5.6 Retrieve Subscriptions

getAffiliations

public List<Affiliation> getAffiliations()
                                  throws rocks.xmpp.core.XmppException

Gets the affiliations for this node.

Returns:

The affiliations for all nodes.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

5.7 Retrieve Affiliations

subscribe

public Subscription subscribe()
                       throws rocks.xmpp.core.XmppException

Subscribes to this node.

Returns:

The subscription.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.1 Subscribe to a Node

subscribe

public Subscription subscribe(rocks.xmpp.extensions.data.model.DataForm dataForm)
                       throws rocks.xmpp.core.XmppException

Subscribes to and configures this node.

Parameters:

dataForm - The configuration form.

Returns:

The subscription.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.3.7 Subscribe and Configure

unsubscribe

public void unsubscribe()
                 throws rocks.xmpp.core.XmppException

Unsubscribes from this node.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.2 Unsubscribe from a Node

unsubscribe

public void unsubscribe(String subscriptionId)
                 throws rocks.xmpp.core.XmppException

Unsubscribes from this node.

Parameters:

subscriptionId - The subscription id.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.2 Unsubscribe from a Node

getSubscriptionOptions

public rocks.xmpp.extensions.data.model.DataForm getSubscriptionOptions()
                                                                 throws rocks.xmpp.core.XmppException

Requests the subscription options for this node.

Returns:

The data form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.3.2 Request

submitSubscriptionOptions

public void submitSubscriptionOptions(rocks.xmpp.extensions.data.model.DataForm dataForm)
                               throws rocks.xmpp.core.XmppException

Submits subscription options for this node.

Parameters:

dataForm - The subscription options form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.3.5 Form Submission

getDefaultSubscriptionOptions

public rocks.xmpp.extensions.data.model.DataForm getDefaultSubscriptionOptions()
                                                                        throws rocks.xmpp.core.XmppException

Gets the default subscription options for a specific node.

Returns:

The default subscription options.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.4 Request Default Subscription Configuration Options

getItems

public List<Item> getItems()
                    throws rocks.xmpp.core.XmppException

Gets all items for this node.

Returns:

The items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.5.2 Requesting All Items

getItems

public List<Item> getItems(String... ids)
                    throws rocks.xmpp.core.XmppException

Gets one or more items with a given item id for a specific node.

Parameters:

ids - The item ids.

Returns:

The items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.5.6 Returning Notifications Only, 6.5.8 Requesting a Particular Item

getItems

public List<Item> getItems(int maxItems)
                    throws rocks.xmpp.core.XmppException

Gets the most recent items.

Parameters:

maxItems - The maximal number of items.

Returns:

The items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.5.7 Requesting the Most Recent Items

publish

public String publish(Object item)
               throws rocks.xmpp.core.XmppException

Publishes an item to this node.

Parameters:

item - The item to be published. Note that this item must be known to the CoreContext, so that it can be marshalled into XML.

Returns:

The item id, generated by the pubsub service.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.1 Publish an Item to a Node

publish

public String publish(String id,
                      Object item)
               throws rocks.xmpp.core.XmppException

Publishes an item to this node.

Parameters:

id - The item's id.

item - The item to be published. Note that this item must be known to the CoreContext, so that it can be marshalled into XML.

Returns:

The item id.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.1 Publish an Item to a Node

create

public String create()
              throws rocks.xmpp.core.XmppException

Creates a node.

Returns:

The node id.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.1 Create a Node

create

public String create(rocks.xmpp.extensions.data.model.DataForm dataForm)
              throws rocks.xmpp.core.XmppException

Creates and configures this node.

Parameters:

dataForm - The configuration form.

Returns:

The node id.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.1.3 Create and Configure a Node

getNodeConfiguration

public rocks.xmpp.extensions.data.model.DataForm getNodeConfiguration()
                                                               throws rocks.xmpp.core.XmppException

Gets the node configuration form.

Returns:

The configuration form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.2.1 Request

submitNodeConfiguration

public void submitNodeConfiguration(rocks.xmpp.extensions.data.model.DataForm dataForm)
                             throws rocks.xmpp.core.XmppException

Submits the node configuration form.

Parameters:

dataForm - The configuration form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.2.4 Form Submission

delete

public void delete()
            throws rocks.xmpp.core.XmppException

Deletes a node on the pubsub service.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.4 Delete a Node

delete

public void delete(URI uri)
            throws rocks.xmpp.core.XmppException

Deletes this node and specifies a replacement node.

Parameters:

uri - The replacement node.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.4 Delete a Node

purge

public void purge()
           throws rocks.xmpp.core.XmppException

Purges this node of all published items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.5 Purge All Node Items

getNodes

public List<PubSubNode> getNodes()
                          throws rocks.xmpp.core.XmppException

Gets the (sub-)nodes, which hierarchically reside under this node, e.g. the "second-level" nodes.

Returns:

The list of nodes.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

5.2 Discover Nodes

getName

public String getName()

Gets the name.

Returns:

The name.

getId

public String getId()

Gets the node id.

Returns:

The node id.

getType

public PubSubNode.Type getType()

Gets the type of this node.

Returns:

The type.

toString

public String toString()

Overrides:

toString in class Object