public final class PubSubManager extends Manager
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateNodesAndPublishItems()
Check if it is possible to create PubSub nodes on this service.
|
LeafNode |
createNode()
Creates an instant node, if supported.
|
LeafNode |
createNode(String nodeId)
Creates a node with default configuration.
|
Node |
createNode(String nodeId,
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.
|
static PubSubManager |
getInstance(XMPPConnection connection)
Get a PubSub manager for the default PubSub service of the connection.
|
static PubSubManager |
getInstance(XMPPConnection connection,
org.jxmpp.jid.BareJid pubSubService)
Get the PubSub manager for the given connection and PubSub service.
|
<T extends Node> |
getNode(String id)
Retrieves the requested node, if it exists.
|
static org.jxmpp.jid.DomainBareJid |
getPubSubService(XMPPConnection connection)
Get the "default" PubSub service for a given XMPP connection.
|
org.jxmpp.jid.BareJid |
getServiceJid()
Get the JID of the PubSub service managed by this manager.
|
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. |
connection, getAuthenticatedConnectionOrThrow
public static PubSubManager getInstance(XMPPConnection connection)
connection
- public static PubSubManager getInstance(XMPPConnection connection, org.jxmpp.jid.BareJid pubSubService)
connection
- the XMPP connection.pubSubService
- the PubSub service.public LeafNode createNode() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public LeafNode createNode(String nodeId) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
nodeId
- The id of the node, which must be unique within the
pubsub serviceXMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public Node createNode(String nodeId, Form config) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
nodeId
- The name of the node, which must be unique within the
pubsub serviceconfig
- The configuration for the nodeXMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public <T extends Node> T getNode(String id) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
id
- - The unique id of the nodeXMPPException.XMPPErrorException
- The node does not existSmackException.NoResponseException
- if there was no response from the server.SmackException.NotConnectedException
InterruptedException
public DiscoverItems discoverNodes(String nodeId) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
nodeId
- - The id of the collection node for which the child
nodes will be returned.DiscoverItems
representing the existing nodesXMPPException.XMPPErrorException
SmackException.NoResponseException
- if there was no response from the server.SmackException.NotConnectedException
InterruptedException
public List<Subscription> getSubscriptions() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public List<Affiliation> getAffiliations() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public void deleteNode(String nodeId) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
nodeId
- XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public ConfigureForm getDefaultConfiguration() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public org.jxmpp.jid.BareJid getServiceJid()
public DiscoverInfo getSupportedFeatures() throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
DiscoverInfo
instance.XMPPException.XMPPErrorException
SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
public boolean canCreateNodesAndPublishItems() throws SmackException.NoResponseException, SmackException.NotConnectedException, InterruptedException, XMPPException.XMPPErrorException
Note that since XEP-60 does not provide an API to determine if an XMPP entity is allowed to
create nodes, therefore this method creates an instant node calling createNode()
to
determine if it is possible to create nodes.
true
if it is possible to create nodes, false
otherwise.SmackException.NoResponseException
SmackException.NotConnectedException
InterruptedException
XMPPException.XMPPErrorException
public static org.jxmpp.jid.DomainBareJid getPubSubService(XMPPConnection connection) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException
connection
- null
.SmackException.NoResponseException
XMPPException.XMPPErrorException
SmackException.NotConnectedException
InterruptedException