ServiceDiscoveryManager (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.core.session.Manager
- - rocks.xmpp.core.session.ExtensionManager
  - - rocks.xmpp.extensions.disco.ServiceDiscoveryManager

```
public final class ServiceDiscoveryManager
extends ExtensionManager
```
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 inbound service discovery requests by responding with a list of enabled extensions (features).

Method Summary

Methods
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`	`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, ResultSetManagement resultSet)` Discovers item associated with another XMPP entity.
`ItemNode`	`discoverItems(Jid jid, String node)` Discovers item associated with another XMPP entity.
`ItemNode`	`discoverItems(Jid jid, String node, ResultSetManagement resultSetManagement)` Discovers item associated with another XMPP entity.
`Collection<Item>`	`discoverServices(String feature)` Discovers a service on the connected server by its feature namespace.
`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.
`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`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener.
`void`	`setItemProvider(ResultSetProvider<Item> itemProvider)` Sets an item provider for the root node.
`void`	`setItemProvider(String node, ResultSetProvider<Item> itemProvider)` Sets an item provider for a node.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager
isEnabled, setEnabled

Methods inherited from class java.lang.Object
equals, 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)
  - getItems
```
public List<Item> getItems()
```
    Gets an unmodifiable list of items.
    
    Returns:
    The items.
  - getIdentities
```
public Set<Identity> getIdentities()
```
    Gets an unmodifiable set of identities.
    
    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.
    
    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.
    
    Returns:
    The extensions.
    See Also:
    addExtension(rocks.xmpp.extensions.data.model.DataForm), removeExtension(rocks.xmpp.extensions.data.model.DataForm), XEP-0128: Service Discovery Extensions
  - 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:
    
    The target entity's identity.
    
    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,
                     ResultSetManagement resultSet)
                       throws XmppException
```
    Discovers item associated with another XMPP entity.
    
    Parameters:
    jid - The JID.
    resultSet - The result set management.
    
    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
  - discoverItems
```
public ItemNode discoverItems(Jid jid,
                     String node,
                     ResultSetManagement resultSetManagement)
                       throws XmppException
```
    Discovers item associated with another XMPP entity.
    
    Parameters:
    jid - The JID.
    node - The node.
    resultSetManagement - The result set management.
    
    Returns:
    The discovered items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - discoverServices
```
public Collection<Item> discoverServices(String feature)
                                  throws XmppException
```
    Discovers a service on the connected server by its feature namespace.
    
    Parameters:
    feature - The feature namespace.
    
    Returns:
    The services, that belong to the namespace.
    
    Throws:
    
    StanzaException - If the server returned a stanza error.
    
    NoResponseException - If the server 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.
  - setItemProvider
```
public void setItemProvider(ResultSetProvider<Item> itemProvider)
```
    Sets an item provider for the root node.
    If you want to manage items in memory, you can use DefaultItemProvider.
    
    Parameters:
    itemProvider - The item provider.
  - setItemProvider
```
public void setItemProvider(String node,
                   ResultSetProvider<Item> itemProvider)
```
    Sets an item provider for a node.
    If you want to manage items in memory, you can use DefaultItemProvider.
    
    Parameters:
    node - The node name.
    itemProvider - The item provider.

Class ServiceDiscoveryManager

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addPropertyChangeListener

removePropertyChangeListener

getItems

getIdentities

getFeatures

getExtensions

addIdentity

removeIdentity

addFeature

removeFeature

addExtension

removeExtension

discoverInformation

discoverInformation

discoverItems

discoverItems

discoverItems

discoverItems

discoverServices

addInfoNode

removeInfoNode

setItemProvider

setItemProvider