PubSubNode (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.pubsub.PubSubNode

```
public final class PubSubNode
extends Object
```
This class represents a single pubsub node.
It allows you to create the node on the pubsub service, subscribe or unsubscribe from the node, retrieve items from it, publish items to it, etc.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureNode(NodeConfiguration nodeConfiguration)` Configures the node by submitting the configuration form.
`void`	`configureSubscription(SubscribeOptions subscribeOptions)` Configures the subscription options for this node.
`String`	`create()` Creates the node on the remote pubsub service.
`String`	`create(NodeConfiguration nodeConfiguration)` Creates and configures this node on the remote pubsub service.
`void`	`delete()` Deletes this node on the pubsub service.
`void`	`delete(URI uri)` Deletes this node and specifies a replacement node.
`List<Item>`	`discoverItems()` Discovers the items for this node.
`NodeMetaData`	`discoverNodeMetaData()` Discovers the node info, which consists of a node name, type and meta data.
`List<PubSubNode>`	`discoverNodes()` Discovers the (sub-)nodes, which hierarchically reside under this node, e.g. the "second-level" nodes.
`List<Affiliation>`	`getAffiliations()` Gets the affiliations for this node.
`SubscribeOptions`	`getDefaultSubscriptionOptions()` Deprecated. Use `getSubscriptionOptions(boolean)`
`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.
`NodeConfiguration`	`getNodeConfiguration()` Gets the node configuration form.
`List<PubSubNode>`	`getNodes()` Deprecated. Use `discoverNodes()`
`SubscribeOptions`	`getSubscriptionOptions()` Gets the subscription options for this node.
`SubscribeOptions`	`getSubscriptionOptions(boolean defaultOptions)` Gets the (default) subscription options for this node.
`SubscribeOptions`	`getSubscriptionOptions(String subId)` Gets the subscription options for this node.
`List<Subscription>`	`getSubscriptions()` Gets the subscriptions for this node.
`NodeType`	`getType()` Gets the type of this node.
`String`	`publish(Object item)` Publishes an item to this node.
`String`	`publish(Object item, PublishOptions publishOptions)` Publishes an item to this node.
`String`	`publish(String id, Object item)` Publishes an item to this node.
`String`	`publish(String id, Object item, PublishOptions publishOptions)` Publishes an item to this node.
`void`	`purge()` Purges this node of all published items.
`void`	`submitNodeConfiguration(DataForm dataForm)` Deprecated. Use `configureNode(rocks.xmpp.extensions.pubsub.model.NodeConfiguration)`
`void`	`submitSubscriptionOptions(DataForm dataForm)` Deprecated. Use `configureSubscription(rocks.xmpp.extensions.pubsub.model.SubscribeOptions)`
`Subscription`	`subscribe()` Subscribes to this node.
`Subscription`	`subscribe(SubscribeOptions subscribeOptions)` Subscribes to and configures this node.
`String`	`toString()` The node id.
`void`	`unsubscribe()` Unsubscribes from this node.
`void`	`unsubscribe(String subscriptionId)` Unsubscribes from this node.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - discoverNodeMetaData
```
public NodeMetaData discoverNodeMetaData()
                                  throws XmppException
```
    Discovers the node info, which consists of a node name, type and meta data.
    
    Returns:
    The node info.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.3 Discover Node Information, 5.4 Discover Node Metadata
  - discoverItems
```
public List<Item> discoverItems()
                         throws XmppException
```
    Discovers the items for this node.
    
    Returns:
    The items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.5 Discover Items for a Node
  - getSubscriptions
```
public List<Subscription> getSubscriptions()
                                    throws XmppException
```
    Gets the subscriptions for this node.
    
    Returns:
    The subscriptions for the node.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.6 Retrieve Subscriptions
  - getAffiliations
```
public List<Affiliation> getAffiliations()
                                  throws XmppException
```
    Gets the affiliations for this node.
    
    Returns:
    The affiliations for all nodes.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.7 Retrieve Affiliations
  - subscribe
```
public Subscription subscribe()
                       throws XmppException
```
    Subscribes to this node.
    
    Returns:
    The subscription.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.1 Subscribe to a Node
  - subscribe
```
public Subscription subscribe(SubscribeOptions subscribeOptions)
                       throws XmppException
```
    Subscribes to and configures this node.
    
    Parameters:
    subscribeOptions - The configuration form.
    
    Returns:
    The subscription.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.7 Subscribe and Configure
  - unsubscribe
```
public void unsubscribe()
                 throws XmppException
```
    Unsubscribes from this node.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.2 Unsubscribe from a Node
  - unsubscribe
```
public void unsubscribe(String subscriptionId)
                 throws XmppException
```
    Unsubscribes from this node.
    
    Parameters:
    subscriptionId - The subscription id.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.2 Unsubscribe from a Node
  - getSubscriptionOptions
```
public SubscribeOptions getSubscriptionOptions(boolean defaultOptions)
                                        throws XmppException
```
    Gets the (default) subscription options for this node.
    
    Parameters:
    defaultOptions - Whether to get the default options or not.
    
    Returns:
    The data form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.2 Request, 6.4 Request Default Subscription Configuration Options, configureSubscription(rocks.xmpp.extensions.pubsub.model.SubscribeOptions)
  - getSubscriptionOptions
```
public SubscribeOptions getSubscriptionOptions()
                                        throws XmppException
```
    Gets the subscription options for this node.
    
    Returns:
    The data form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.2 Request, configureSubscription(rocks.xmpp.extensions.pubsub.model.SubscribeOptions)
  - getSubscriptionOptions
```
public SubscribeOptions getSubscriptionOptions(String subId)
                                        throws XmppException
```
    Gets the subscription options for this node.
    
    Parameters:
    subId - The subscription id.
    
    Returns:
    The data form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.2 Request, configureSubscription(rocks.xmpp.extensions.pubsub.model.SubscribeOptions)
  - submitSubscriptionOptions
```
@Deprecated
public void submitSubscriptionOptions(DataForm dataForm)
                               throws XmppException
```
    Deprecated. Use configureSubscription(rocks.xmpp.extensions.pubsub.model.SubscribeOptions)
    
    Submits subscription options for this node.
    
    Parameters:
    dataForm - The subscription options form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.5 Form Submission
  - configureSubscription
```
public void configureSubscription(SubscribeOptions subscribeOptions)
                           throws XmppException
```
    Configures the subscription options for this node.
    
    Parameters:
    subscribeOptions - The subscription options form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.3.5 Form Submission
  - getDefaultSubscriptionOptions
```
@Deprecated
public SubscribeOptions getDefaultSubscriptionOptions()
                                               throws XmppException
```
    Deprecated. Use getSubscriptionOptions(boolean)
    
    Gets the default subscription options for a specific node.
    
    Returns:
    The default subscription options.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.4 Request Default Subscription Configuration Options
  - getItems
```
public List<Item> getItems()
                    throws XmppException
```
    Gets all items for this node.
    
    Returns:
    The items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.5.2 Requesting All Items
  - getItems
```
public List<Item> getItems(String... ids)
                    throws XmppException
```
    Gets one or more items with a given item id for a specific node.
    
    Parameters:
    ids - The item ids.
    
    Returns:
    The items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.5.6 Returning Notifications Only, 6.5.8 Requesting a Particular Item
  - getItems
```
public List<Item> getItems(int maxItems)
                    throws XmppException
```
    Gets the most recent items.
    
    Parameters:
    maxItems - The maximal number of items.
    
    Returns:
    The items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    6.5.7 Requesting the Most Recent Items
  - publish
```
public String publish(Object item)
               throws 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:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.1 Publish an Item to a Node
  - publish
```
public String publish(Object item,
             PublishOptions publishOptions)
               throws 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.
    publishOptions - The optional publish options.
    
    Returns:
    The item id, generated by the pubsub service.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.1 Publish an Item to a Node
  - publish
```
public String publish(String id,
             Object item)
               throws 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:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.1 Publish an Item to a Node
  - publish
```
public String publish(String id,
             Object item,
             PublishOptions publishOptions)
               throws 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.
    publishOptions - The optional publish options.
    
    Returns:
    The item id.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.1.5 Publishing Options
  - create
```
public String create()
              throws XmppException
```
    Creates the node on the remote pubsub service.
    
    Returns:
    The node id, if it wasn't already set.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.1 Create a Node
  - create
```
public String create(NodeConfiguration nodeConfiguration)
              throws XmppException
```
    Creates and configures this node on the remote pubsub service.
    
    Parameters:
    nodeConfiguration - The configuration form.
    
    Returns:
    The node id.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.1.3 Create and Configure a Node
  - getNodeConfiguration
```
public NodeConfiguration getNodeConfiguration()
                                       throws XmppException
```
    Gets the node configuration form.
    
    Returns:
    The configuration form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.2.1 Request
  - submitNodeConfiguration
```
@Deprecated
public void submitNodeConfiguration(DataForm dataForm)
                             throws XmppException
```
    Deprecated. Use configureNode(rocks.xmpp.extensions.pubsub.model.NodeConfiguration)
    
    Submits the node configuration form.
    
    Parameters:
    dataForm - The configuration form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.2.4 Form Submission
  - configureNode
```
public void configureNode(NodeConfiguration nodeConfiguration)
                   throws XmppException
```
    Configures the node by submitting the configuration form.
    
    Parameters:
    nodeConfiguration - The configuration form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.2.4 Form Submission
  - delete
```
public void delete()
            throws XmppException
```
    Deletes this node on the pubsub service.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.4 Delete a Node
  - delete
```
public void delete(URI uri)
            throws XmppException
```
    Deletes this node and specifies a replacement node.
    
    Parameters:
    uri - The replacement node.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.4 Delete a Node
  - purge
```
public void purge()
           throws XmppException
```
    Purges this node of all published items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.5 Purge All Node Items
  - discoverNodes
```
public List<PubSubNode> discoverNodes()
                               throws XmppException
```
    Discovers the (sub-)nodes, which hierarchically reside under this node, e.g. the "second-level" nodes.
    
    Returns:
    The list of nodes.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.2 Discover Nodes
  - getNodes
```
@Deprecated
public List<PubSubNode> getNodes()
                          throws XmppException
```
    Deprecated. Use discoverNodes()
    
    Gets the (sub-)nodes, which hierarchically reside under this node, e.g. the "second-level" nodes.
    
    Returns:
    The list of nodes.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    5.2 Discover Nodes
  - getId
```
public String getId()
```
    Gets the node id.
    
    Returns:
    The node id.
  - getType
```
public NodeType getType()
```
    Gets the type of this node.
    
    Returns:
    The type.
  - toString
```
public String toString()
```
    The node id.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The node id.

Class PubSubNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

discoverNodeMetaData

discoverItems

getSubscriptions

getAffiliations

subscribe

subscribe

unsubscribe

unsubscribe

getSubscriptionOptions

getSubscriptionOptions

getSubscriptionOptions

submitSubscriptionOptions

configureSubscription

getDefaultSubscriptionOptions

getItems

getItems

getItems

publish

publish

publish

publish

create

create

getNodeConfiguration

submitNodeConfiguration

configureNode

delete

delete

purge

discoverNodes

getNodes

getId

getType

toString