2003-08-24 18:05:45 +02:00
|
|
|
/**
|
|
|
|
*
|
2007-02-12 01:59:05 +01:00
|
|
|
* Copyright 2003-2007 Jive Software.
|
2003-08-24 18:05:45 +02:00
|
|
|
*
|
2014-02-17 18:57:38 +01:00
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
2004-11-03 00:37:00 +01:00
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
2003-08-24 18:05:45 +02:00
|
|
|
*
|
2004-11-03 00:37:00 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2003-08-24 18:05:45 +02:00
|
|
|
*
|
2004-11-03 00:37:00 +01:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
2003-08-24 18:05:45 +02:00
|
|
|
*/
|
2014-02-15 11:35:08 +01:00
|
|
|
package org.jivesoftware.smackx.xroster;
|
2003-08-24 18:05:45 +02:00
|
|
|
|
2014-03-03 11:53:55 +01:00
|
|
|
import java.lang.ref.WeakReference;
|
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.HashSet;
|
2009-06-04 15:09:25 +02:00
|
|
|
import java.util.Iterator;
|
2014-03-03 11:53:55 +01:00
|
|
|
import java.util.Map;
|
|
|
|
import java.util.Set;
|
|
|
|
import java.util.WeakHashMap;
|
2009-06-04 15:09:25 +02:00
|
|
|
|
|
|
|
import org.jivesoftware.smack.PacketListener;
|
2014-03-19 14:22:20 +01:00
|
|
|
import org.jivesoftware.smack.SmackException.NotConnectedException;
|
2014-03-10 09:45:50 +01:00
|
|
|
import org.jivesoftware.smack.XMPPConnection;
|
2015-02-26 18:41:17 +01:00
|
|
|
import org.jivesoftware.smack.filter.StanzaExtensionFilter;
|
|
|
|
import org.jivesoftware.smack.filter.StanzaFilter;
|
2009-06-04 15:09:25 +02:00
|
|
|
import org.jivesoftware.smack.packet.Message;
|
2015-02-05 11:17:27 +01:00
|
|
|
import org.jivesoftware.smack.packet.Stanza;
|
2015-01-22 13:53:50 +01:00
|
|
|
import org.jivesoftware.smack.roster.Roster;
|
|
|
|
import org.jivesoftware.smack.roster.RosterEntry;
|
|
|
|
import org.jivesoftware.smack.roster.RosterGroup;
|
2014-02-15 11:35:08 +01:00
|
|
|
import org.jivesoftware.smackx.xroster.packet.RosterExchange;
|
2003-08-24 18:05:45 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
|
|
|
public class RosterExchangeManager {
|
|
|
|
|
2014-03-03 11:53:55 +01:00
|
|
|
public final static String NAMESPACE = "jabber:x:roster";
|
|
|
|
public final static String ELEMENT = "x";
|
|
|
|
|
2014-12-27 13:37:02 +01:00
|
|
|
private final static Map<XMPPConnection, RosterExchangeManager> INSTANCES = new WeakHashMap<>();
|
2014-03-03 11:53:55 +01:00
|
|
|
|
2015-02-26 18:41:17 +01:00
|
|
|
private final static StanzaFilter PACKET_FILTER = new StanzaExtensionFilter(ELEMENT, NAMESPACE);
|
2003-08-24 18:05:45 +02:00
|
|
|
|
2014-03-03 11:53:55 +01:00
|
|
|
private final Set<RosterExchangeListener> rosterExchangeListeners = Collections.synchronizedSet(new HashSet<RosterExchangeListener>());
|
2003-08-24 18:05:45 +02:00
|
|
|
|
2014-03-10 09:45:50 +01:00
|
|
|
private final WeakReference<XMPPConnection> weakRefConnection;
|
2014-03-03 11:53:55 +01:00
|
|
|
private final PacketListener packetListener;
|
|
|
|
|
2014-03-10 09:45:50 +01:00
|
|
|
public synchronized static RosterExchangeManager getInstanceFor(XMPPConnection connection) {
|
2014-03-03 11:53:55 +01:00
|
|
|
RosterExchangeManager rosterExchangeManager = INSTANCES.get(connection);
|
|
|
|
if (rosterExchangeManager == null) {
|
|
|
|
rosterExchangeManager = new RosterExchangeManager(connection);
|
2014-12-27 13:37:02 +01:00
|
|
|
INSTANCES.put(connection, rosterExchangeManager);
|
2014-03-03 11:53:55 +01:00
|
|
|
}
|
|
|
|
return rosterExchangeManager;
|
|
|
|
}
|
2003-08-24 18:05:45 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new roster exchange manager.
|
|
|
|
*
|
2015-02-12 12:13:19 +01:00
|
|
|
* @param connection an XMPPConnection which is used to send and receive messages.
|
2003-08-24 18:05:45 +02:00
|
|
|
*/
|
2014-03-10 09:45:50 +01:00
|
|
|
public RosterExchangeManager(XMPPConnection connection) {
|
|
|
|
weakRefConnection = new WeakReference<XMPPConnection>(connection);
|
2014-03-03 11:53:55 +01:00
|
|
|
// Listens for all roster exchange packets and fire the roster exchange listeners.
|
|
|
|
packetListener = new PacketListener() {
|
2015-02-05 11:17:27 +01:00
|
|
|
public void processPacket(Stanza packet) {
|
2014-03-03 11:53:55 +01:00
|
|
|
Message message = (Message) packet;
|
|
|
|
RosterExchange rosterExchange =
|
|
|
|
(RosterExchange) message.getExtension(ELEMENT, NAMESPACE);
|
|
|
|
// Fire event for roster exchange listeners
|
|
|
|
fireRosterExchangeListeners(message.getFrom(), rosterExchange.getRosterEntries());
|
2014-11-09 11:02:49 +01:00
|
|
|
}
|
2014-03-03 11:53:55 +01:00
|
|
|
};
|
2015-01-05 21:42:35 +01:00
|
|
|
connection.addAsyncPacketListener(packetListener, PACKET_FILTER);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a listener to roster exchanges. The listener will be fired anytime roster entries
|
|
|
|
* are received from remote XMPP clients.
|
|
|
|
*
|
|
|
|
* @param rosterExchangeListener a roster exchange listener.
|
|
|
|
*/
|
|
|
|
public void addRosterListener(RosterExchangeListener rosterExchangeListener) {
|
2014-03-03 11:53:55 +01:00
|
|
|
rosterExchangeListeners.add(rosterExchangeListener);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Removes a listener from roster exchanges. The listener will be fired anytime roster
|
|
|
|
* entries are received from remote XMPP clients.
|
|
|
|
*
|
|
|
|
* @param rosterExchangeListener a roster exchange listener..
|
|
|
|
*/
|
|
|
|
public void removeRosterListener(RosterExchangeListener rosterExchangeListener) {
|
2014-03-03 11:53:55 +01:00
|
|
|
rosterExchangeListeners.remove(rosterExchangeListener);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends a roster to userID. All the entries of the roster will be sent to the
|
|
|
|
* target user.
|
|
|
|
*
|
|
|
|
* @param roster the roster to send
|
|
|
|
* @param targetUserID the user that will receive the roster entries
|
2014-03-19 14:22:20 +01:00
|
|
|
* @throws NotConnectedException
|
2003-08-24 18:05:45 +02:00
|
|
|
*/
|
2014-03-19 14:22:20 +01:00
|
|
|
public void send(Roster roster, String targetUserID) throws NotConnectedException {
|
2003-08-24 18:05:45 +02:00
|
|
|
// Create a new message to send the roster
|
|
|
|
Message msg = new Message(targetUserID);
|
|
|
|
// Create a RosterExchange Package and add it to the message
|
|
|
|
RosterExchange rosterExchange = new RosterExchange(roster);
|
|
|
|
msg.addExtension(rosterExchange);
|
|
|
|
|
2014-03-10 09:45:50 +01:00
|
|
|
XMPPConnection connection = weakRefConnection.get();
|
2003-08-24 18:05:45 +02:00
|
|
|
// Send the message that contains the roster
|
2014-03-03 11:53:55 +01:00
|
|
|
connection.sendPacket(msg);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends a roster entry to userID.
|
|
|
|
*
|
|
|
|
* @param rosterEntry the roster entry to send
|
|
|
|
* @param targetUserID the user that will receive the roster entries
|
2014-03-19 14:22:20 +01:00
|
|
|
* @throws NotConnectedException
|
2003-08-24 18:05:45 +02:00
|
|
|
*/
|
2014-03-19 14:22:20 +01:00
|
|
|
public void send(RosterEntry rosterEntry, String targetUserID) throws NotConnectedException {
|
2003-08-24 18:05:45 +02:00
|
|
|
// Create a new message to send the roster
|
|
|
|
Message msg = new Message(targetUserID);
|
|
|
|
// Create a RosterExchange Package and add it to the message
|
|
|
|
RosterExchange rosterExchange = new RosterExchange();
|
|
|
|
rosterExchange.addRosterEntry(rosterEntry);
|
|
|
|
msg.addExtension(rosterExchange);
|
|
|
|
|
2014-03-10 09:45:50 +01:00
|
|
|
XMPPConnection connection = weakRefConnection.get();
|
2003-08-24 18:05:45 +02:00
|
|
|
// Send the message that contains the roster
|
2014-03-03 11:53:55 +01:00
|
|
|
connection.sendPacket(msg);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends a roster group to userID. All the entries of the group will be sent to the
|
|
|
|
* target user.
|
|
|
|
*
|
|
|
|
* @param rosterGroup the roster group to send
|
|
|
|
* @param targetUserID the user that will receive the roster entries
|
2014-03-19 14:22:20 +01:00
|
|
|
* @throws NotConnectedException
|
2003-08-24 18:05:45 +02:00
|
|
|
*/
|
2014-03-19 14:22:20 +01:00
|
|
|
public void send(RosterGroup rosterGroup, String targetUserID) throws NotConnectedException {
|
2003-08-24 18:05:45 +02:00
|
|
|
// Create a new message to send the roster
|
|
|
|
Message msg = new Message(targetUserID);
|
|
|
|
// Create a RosterExchange Package and add it to the message
|
|
|
|
RosterExchange rosterExchange = new RosterExchange();
|
2006-07-17 10:39:08 +02:00
|
|
|
for (RosterEntry entry : rosterGroup.getEntries()) {
|
|
|
|
rosterExchange.addRosterEntry(entry);
|
|
|
|
}
|
2003-08-24 18:05:45 +02:00
|
|
|
msg.addExtension(rosterExchange);
|
|
|
|
|
2014-03-10 09:45:50 +01:00
|
|
|
XMPPConnection connection = weakRefConnection.get();
|
2003-08-24 18:05:45 +02:00
|
|
|
// Send the message that contains the roster
|
2014-03-03 11:53:55 +01:00
|
|
|
connection.sendPacket(msg);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Fires roster exchange listeners.
|
|
|
|
*/
|
2012-10-26 12:47:55 +02:00
|
|
|
private void fireRosterExchangeListeners(String from, Iterator<RemoteRosterEntry> remoteRosterEntries) {
|
2003-08-24 18:05:45 +02:00
|
|
|
RosterExchangeListener[] listeners = null;
|
|
|
|
synchronized (rosterExchangeListeners) {
|
|
|
|
listeners = new RosterExchangeListener[rosterExchangeListeners.size()];
|
|
|
|
rosterExchangeListeners.toArray(listeners);
|
|
|
|
}
|
|
|
|
for (int i = 0; i < listeners.length; i++) {
|
2003-08-25 01:05:54 +02:00
|
|
|
listeners[i].entriesReceived(from, remoteRosterEntries);
|
2003-08-24 18:05:45 +02:00
|
|
|
}
|
|
|
|
}
|
2014-02-17 23:58:40 +01:00
|
|
|
}
|