org.jivesoftware.smackx
Class RosterExchangeManager

java.lang.Object
  org.jivesoftware.smackx.RosterExchangeManager

public class RosterExchangeManager
extends Object

Manages Roster exchanges. A RosterExchangeManager provides a high level access to send rosters, roster groups and roster entries to XMPP clients. It also provides an easy way to hook up custom logic when entries are received from another XMPP client through RosterExchangeListeners.

Author:

Gaston Dombiak

Constructor Summary

RosterExchangeManager(Connection con)
Creates a new roster exchange manager.

Method Summary

void	addRosterListener(RosterExchangeListener rosterExchangeListener) Adds a listener to roster exchanges.
void	destroy()
protected void	finalize()
void	removeRosterListener(RosterExchangeListener rosterExchangeListener) Removes a listener from roster exchanges.
void	send(RosterEntry rosterEntry, String targetUserID) Sends a roster entry to userID.
void	send(RosterGroup rosterGroup, String targetUserID) Sends a roster group to userID.
void	send(Roster roster, String targetUserID) Sends a roster to userID.

Methods inherited from class java.lang.Object

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

Constructor Detail

RosterExchangeManager

public RosterExchangeManager(Connection con)

Creates a new roster exchange manager.

Parameters:

con - a Connection which is used to send and receive messages.

Method Detail

addRosterListener

public void addRosterListener(RosterExchangeListener rosterExchangeListener)

Adds a listener to roster exchanges. The listener will be fired anytime roster entries are received from remote XMPP clients.

Parameters:

rosterExchangeListener - a roster exchange listener.

removeRosterListener

public void removeRosterListener(RosterExchangeListener rosterExchangeListener)

Removes a listener from roster exchanges. The listener will be fired anytime roster entries are received from remote XMPP clients.

Parameters:

rosterExchangeListener - a roster exchange listener..

send

public void send(Roster roster,
                 String targetUserID)

Sends a roster to userID. All the entries of the roster will be sent to the target user.

Parameters:

roster - the roster to send

targetUserID - the user that will receive the roster entries

send

public void send(RosterEntry rosterEntry,
                 String targetUserID)

Sends a roster entry to userID.

Parameters:

rosterEntry - the roster entry to send

targetUserID - the user that will receive the roster entries

send

public void send(RosterGroup rosterGroup,
                 String targetUserID)

Sends a roster group to userID. All the entries of the group will be sent to the target user.

Parameters:

rosterGroup - the roster group to send

targetUserID - the user that will receive the roster entries

destroy

public void destroy()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable