org.jivesoftware.smackx.pubsub

Class PubSubManager

java.lang.Object

org.jivesoftware.smackx.pubsub.PubSubManager

public final class PubSubManager
extends Object

This is the starting point for access to the pubsub service. It will provide access to general information about the service, as well as create or retrieve pubsub LeafNode instances. These instances provide the bulk of the functionality as defined in the pubsub specification XEP-0060.

Constructor Summary

Constructors

Constructor and Description
PubSubManager(XMPPConnection connection) Create a pubsub manager associated to the specified connection.
PubSubManager(XMPPConnection connection, String toAddress) Create a pubsub manager associated to the specified connection where the pubsub requests require a specific to address for packets.

Method Summary

Modifier and Type	Method and Description
LeafNode	createNode() Creates an instant node, if supported.
LeafNode	createNode(String id) Creates a node with default configuration.
Node	createNode(String name, Form config) Creates a node with specified configuration.
void	deleteNode(String nodeId) Delete the specified node
DiscoverItems	discoverNodes(String nodeId) Get all the nodes that currently exist as a child of the specified collection node.
List<Affiliation>	getAffiliations() Gets the affiliations on the root node.
ConfigureForm	getDefaultConfiguration() Returns the default settings for Node configuration.
<T extends Node> T	getNode(String id) Retrieves the requested node, if it exists.
List<Subscription>	getSubscriptions() Gets the subscriptions on the root node.
DiscoverInfo	getSupportedFeatures() Gets the supported features of the servers pubsub implementation as a standard DiscoverInfo instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

PubSubManager

public PubSubManager(XMPPConnection connection)

Create a pubsub manager associated to the specified connection. Defaults the service name to pubsub

Parameters:

connection - The XMPP connection

PubSubManager

public PubSubManager(XMPPConnection connection,
                     String toAddress)

Create a pubsub manager associated to the specified connection where the pubsub requests require a specific to address for packets.

Parameters:

connection - The XMPP connection

toAddress - The pubsub specific to address (required for some servers)

Method Detail

createNode

public LeafNode createNode()
                    throws SmackException.NoResponseException,
                           XMPPException.XMPPErrorException,
                           SmackException.NotConnectedException

Creates an instant node, if supported.

Returns:

The node that was created

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

createNode

public LeafNode createNode(String id)
                    throws SmackException.NoResponseException,
                           XMPPException.XMPPErrorException,
                           SmackException.NotConnectedException

Creates a node with default configuration.

Parameters:

id - The id of the node, which must be unique within the pubsub service

Returns:

The node that was created

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

createNode

public Node createNode(String name,
                       Form config)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException

Creates a node with specified configuration. Note: This is the only way to create a collection node.

Parameters:

name - The name of the node, which must be unique within the pubsub service

config - The configuration for the node

Returns:

The node that was created

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getNode

public <T extends Node> T getNode(String id)
                           throws SmackException.NoResponseException,
                                  XMPPException.XMPPErrorException,
                                  SmackException.NotConnectedException

Retrieves the requested node, if it exists. It will throw an exception if it does not.

Parameters:

id - - The unique id of the node

Returns:

the node

Throws:

XMPPException.XMPPErrorException - The node does not exist

SmackException.NoResponseException - if there was no response from the server.

SmackException.NotConnectedException

discoverNodes

public DiscoverItems discoverNodes(String nodeId)
                            throws SmackException.NoResponseException,
                                   XMPPException.XMPPErrorException,
                                   SmackException.NotConnectedException

Get all the nodes that currently exist as a child of the specified collection node. If the service does not support collection nodes then all nodes will be returned. To retrieve contents of the root collection node (if it exists), or there is no root collection node, pass null as the nodeId.

Parameters:

nodeId - - The id of the collection node for which the child nodes will be returned.

Returns:

DiscoverItems representing the existing nodes

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException - if there was no response from the server.

SmackException.NotConnectedException

getSubscriptions

public List<Subscription> getSubscriptions()
                                    throws SmackException.NoResponseException,
                                           XMPPException.XMPPErrorException,
                                           SmackException.NotConnectedException

Gets the subscriptions on the root node.

Returns:

List of exceptions

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getAffiliations

public List<Affiliation> getAffiliations()
                                  throws SmackException.NoResponseException,
                                         XMPPException.XMPPErrorException,
                                         SmackException.NotConnectedException

Gets the affiliations on the root node.

Returns:

List of affiliations

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

deleteNode

public void deleteNode(String nodeId)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException

Delete the specified node

Parameters:

nodeId -

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getDefaultConfiguration

public ConfigureForm getDefaultConfiguration()
                                      throws SmackException.NoResponseException,
                                             XMPPException.XMPPErrorException,
                                             SmackException.NotConnectedException

Returns the default settings for Node configuration.

Returns:

configuration form containing the default settings.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

getSupportedFeatures

public DiscoverInfo getSupportedFeatures()
                                  throws SmackException.NoResponseException,
                                         XMPPException.XMPPErrorException,
                                         SmackException.NotConnectedException

Gets the supported features of the servers pubsub implementation as a standard DiscoverInfo instance.

Returns:

The supported features

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException