rocks.xmpp.extensions.reach

Class ReachabilityManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.reach.ReachabilityManager

public final class ReachabilityManager
extends ExtensionManager

Allows to query for reachability addresses of another contact, automatically responds to reachability queries and notifies ReachabilityListeners, when the reachability of a contact has changed either via presence or PEP.

By default this manager is not enabled. If you support reachability addresses you have to enable it.

Author:

Christian Schudt

Field Summary

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

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	addReachabilityListener(ReachabilityListener reachabilityListener) Adds a reachability listener, which allows to listen for reachability updates.
List<Address>	getReachabilityAddresses()
void	removeReachabilityListener(ReachabilityListener reachabilityListener) Removes a previously added reachability listener.
List<Address>	requestReachabilityAddresses(rocks.xmpp.core.Jid contact) Requests the reachability addresses of a contact.

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

getReachabilityAddresses

public List<Address> getReachabilityAddresses()

addReachabilityListener

public void addReachabilityListener(ReachabilityListener reachabilityListener)

Adds a reachability listener, which allows to listen for reachability updates.

Parameters:

reachabilityListener - The listener.

See Also:

removeReachabilityListener(ReachabilityListener)

removeReachabilityListener

public void removeReachabilityListener(ReachabilityListener reachabilityListener)

Removes a previously added reachability listener.

Parameters:

reachabilityListener - The listener.

See Also:

addReachabilityListener(ReachabilityListener)

requestReachabilityAddresses

public List<Address> requestReachabilityAddresses(rocks.xmpp.core.Jid contact)
                                           throws rocks.xmpp.core.XmppException

Requests the reachability addresses of a contact.

Parameters:

contact - The contact.

Returns:

The reachability addresses.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException