rocks.xmpp.extensions.disco

Class ServiceDiscoveryManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.disco.ServiceDiscoveryManager

All Implemented Interfaces:

InfoNode, ItemNode

public final class ServiceDiscoveryManager
extends ExtensionManager
implements InfoNode, ItemNode

Manages XEP-0030: Service Discovery.

1. Introduction

The ability to discover information about entities on the Jabber network is extremely valuable. Such information might include features offered or protocols supported by the entity, the entity's type or identity, and additional entities that are associated with the original entity in some way (often thought of as "children" of the "parent" entity).

Enabled extensions are automatically added to the list of features by their respective manager class. Disabled extensions are removed.

This class automatically manages incoming service discovery requests by responding with a list of enabled extensions (features).

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

xmppSession

Method Summary

Modifier and Type	Method and Description
void	addExtension(DataForm extension) Adds an extension.
void	addFeature(Feature feature) Adds a feature.
void	addIdentity(Identity identity) Adds an identity.
void	addInfoNode(InfoNode infoNode) Adds an info node.
void	addItem(Item item) Adds an item.
void	addItemNode(ItemNode itemNode) Adds an item node.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener, which listens for changes in the identities, features, extensions and items collections.
InfoNode	discoverInformation(Jid jid) Discovers information about another XMPP entity.
InfoNode	discoverInformation(Jid jid, String node) Discovers information about another XMPP entity targeted at a specific node.
ItemNode	discoverItems(Jid jid) Discovers item associated with another XMPP entity.
ItemNode	discoverItems(Jid jid, String node) Discovers item associated with another XMPP entity.
List<DataForm>	getExtensions() Gets an unmodifiable list of extensions.
Set<Feature>	getFeatures() Gets an unmodifiable set of features.
Set<Identity>	getIdentities() Gets an unmodifiable set of identities.
List<Item>	getItems() Gets an unmodifiable list of items.
String	getNode() Since this is the "root" node, it returns null.
void	removeExtension(DataForm extension) Removes an extension.
void	removeFeature(Feature feature) Removes a feature.
void	removeIdentity(Identity identity) Removes an identity.
void	removeInfoNode(String node) Removes an info node.
void	removeItem(Item item) Removes an item.
void	removeItemNode(String node) Removes an item node.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

setEnabled

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener, which listens for changes in the identities, features, extensions and items collections.

Parameters:

listener - The listener.

See Also:

removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener.

Parameters:

listener - The listener.

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)

getNode

public String getNode()

Since this is the "root" node, it returns null.

Specified by:

getNode in interface InfoNode

Specified by:

getNode in interface ItemNode

Returns:

null

getItems

public List<Item> getItems()

Gets an unmodifiable list of items.

Specified by:

getItems in interface ItemNode

Returns:

The items.

See Also:

addItem(rocks.xmpp.extensions.disco.model.items.Item), removeItem(rocks.xmpp.extensions.disco.model.items.Item)

getIdentities

public Set<Identity> getIdentities()

Gets an unmodifiable set of identities.

Specified by:

getIdentities in interface InfoNode

Returns:

The identities.

See Also:

addIdentity(rocks.xmpp.extensions.disco.model.info.Identity), removeIdentity(rocks.xmpp.extensions.disco.model.info.Identity)

getFeatures

public Set<Feature> getFeatures()

Gets an unmodifiable set of features.

Specified by:

getFeatures in interface InfoNode

Returns:

The features.

See Also:

addFeature(rocks.xmpp.extensions.disco.model.info.Feature), removeFeature(rocks.xmpp.extensions.disco.model.info.Feature)

getExtensions

public List<DataForm> getExtensions()

Gets an unmodifiable list of extensions.

Specified by:

getExtensions in interface InfoNode

Returns:

The extensions.

See Also:

addExtension(rocks.xmpp.extensions.data.model.DataForm), removeExtension(rocks.xmpp.extensions.data.model.DataForm), XEP-0128: Service Discovery Extensions

addItem

public void addItem(Item item)

Adds an item.

Parameters:

item - The item.

See Also:

removeItem(rocks.xmpp.extensions.disco.model.items.Item), ()

removeItem

public void removeItem(Item item)

Removes an item.

Parameters:

item - The item.

See Also:

addItem(rocks.xmpp.extensions.disco.model.items.Item), getItems()

addIdentity

public void addIdentity(Identity identity)

Adds an identity.

Parameters:

identity - The identity.

See Also:

removeIdentity(rocks.xmpp.extensions.disco.model.info.Identity), getIdentities()

removeIdentity

public void removeIdentity(Identity identity)

Removes an identity.

Parameters:

identity - The identity.

See Also:

addIdentity(rocks.xmpp.extensions.disco.model.info.Identity), getIdentities()

addFeature

public void addFeature(Feature feature)

Adds a feature. Features should not be added or removed directly. Instead enable or disable the respective extension manager, which will then add or remove the feature. That way, supported features are consistent with enabled extension managers and service discovery won't reveal features, that are in fact not supported.

Parameters:

feature - The feature.

See Also:

removeFeature(rocks.xmpp.extensions.disco.model.info.Feature), getFeatures()

removeFeature

public void removeFeature(Feature feature)

Removes a feature.

Parameters:

feature - The feature.

See Also:

addFeature(rocks.xmpp.extensions.disco.model.info.Feature), getFeatures()

addExtension

public void addExtension(DataForm extension)

Adds an extension.

Parameters:

extension - The extension.

See Also:

removeExtension(rocks.xmpp.extensions.data.model.DataForm), getExtensions(), XEP-0128: Service Discovery Extensions

removeExtension

public void removeExtension(DataForm extension)

Removes an extension.

Parameters:

extension - The extension.

See Also:

addExtension(rocks.xmpp.extensions.data.model.DataForm), getExtensions(), XEP-0128: Service Discovery Extensions

discoverInformation

public InfoNode discoverInformation(Jid jid)
                             throws XmppException

Discovers information about another XMPP entity.

3. Discovering Information About a Jabber Entity

A requesting entity may want to discover information about another entity on the network. The information desired generally is of two kinds:

1. The target entity's identity.
2. The features offered and protocols supported by the target entity.

Parameters:

jid - The entity's JID.

Returns:

The service discovery result.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

discoverInformation

public InfoNode discoverInformation(Jid jid,
                                    String node)
                             throws XmppException

Discovers information about another XMPP entity targeted at a specific node.

3.2 Info Nodes

A disco#info query MAY also be directed to a specific node identifier associated with a JID.

Parameters:

jid - The entity's JID.

node - The node.

Returns:

The info discovery result or null, if info discovery is not supported.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

discoverInformation(rocks.xmpp.core.Jid)

discoverItems

public ItemNode discoverItems(Jid jid)
                       throws XmppException

Discovers item associated with another XMPP entity.

Parameters:

jid - The JID.

Returns:

The discovered items.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

discoverItems

public ItemNode discoverItems(Jid jid,
                              String node)
                       throws XmppException

Discovers item associated with another XMPP entity.

Parameters:

jid - The JID.

node - The node.

Returns:

The discovered items.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

addInfoNode

public void addInfoNode(InfoNode infoNode)

Adds an info node.

Parameters:

infoNode - The info node.

removeInfoNode

public void removeInfoNode(String node)

Removes an info node.

Parameters:

node - The node name.

addItemNode

public void addItemNode(ItemNode itemNode)

Adds an item node.

Parameters:

itemNode - The item node.

removeItemNode

public void removeItemNode(String node)

Removes an item node.

Parameters:

node - The item node.