RosterExchangeManager.java

  1. /**
  2.  *
  3.  * Copyright 2003-2007 Jive Software.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smackx.xroster;

  19. import java.lang.ref.WeakReference;
  20. import java.util.Collections;
  21. import java.util.HashSet;
  22. import java.util.Iterator;
  23. import java.util.Map;
  24. import java.util.Set;
  25. import java.util.WeakHashMap;

  27. import org.jivesoftware.smack.SmackException.NotConnectedException;
  28. import org.jivesoftware.smack.StanzaListener;
  29. import org.jivesoftware.smack.XMPPConnection;
  30. import org.jivesoftware.smack.filter.StanzaExtensionFilter;
  31. import org.jivesoftware.smack.filter.StanzaFilter;
  32. import org.jivesoftware.smack.packet.Message;
  33. import org.jivesoftware.smack.packet.MessageBuilder;
  34. import org.jivesoftware.smack.packet.Stanza;
  35. import org.jivesoftware.smack.roster.Roster;
  36. import org.jivesoftware.smack.roster.RosterEntry;
  37. import org.jivesoftware.smack.roster.RosterGroup;

  39. import org.jivesoftware.smackx.xroster.packet.RosterExchange;

  41. import org.jxmpp.jid.Jid;

  43. /**
  44.  *
  45.  * Manages Roster exchanges. A RosterExchangeManager provides high level access to send
  46.  * rosters, roster groups and roster entries to XMPP clients. It also provides an easy way
  47.  * to hook up custom logic when entries are received from another XMPP client through
  48.  * RosterExchangeListeners.
  49.  *
  50.  * @author Gaston Dombiak
  51.  */
  52. public class RosterExchangeManager {

  54.     public static final String NAMESPACE = "jabber:x:roster";
  55.     public static final String ELEMENT = "x";

  57.     private static final Map<XMPPConnection, RosterExchangeManager> INSTANCES = new WeakHashMap<>();

  59.     private static final StanzaFilter PACKET_FILTER = new StanzaExtensionFilter(ELEMENT, NAMESPACE);

  61.     private final Set<RosterExchangeListener> rosterExchangeListeners = Collections.synchronizedSet(new HashSet<RosterExchangeListener>());

  63.     private final WeakReference<XMPPConnection> weakRefConnection;
  64.     private final StanzaListener packetListener;

  66.     public static synchronized RosterExchangeManager getInstanceFor(XMPPConnection connection) {
  67.         RosterExchangeManager rosterExchangeManager = INSTANCES.get(connection);
  68.         if (rosterExchangeManager == null) {
  69.             rosterExchangeManager = new RosterExchangeManager(connection);
  70.             INSTANCES.put(connection, rosterExchangeManager);
  71.         }
  72.         return rosterExchangeManager;
  73.     }

  75.     /**
  76.      * Creates a new roster exchange manager.
  77.      *
  78.      * @param connection an XMPPConnection which is used to send and receive messages.
  79.      */
  80.     public RosterExchangeManager(XMPPConnection connection) {
  81.         weakRefConnection = new WeakReference<>(connection);
  82.         // Listens for all roster exchange packets and fire the roster exchange listeners.
  83.         packetListener = new StanzaListener() {
  84.             @Override
  85.             public void processStanza(Stanza packet) {
  86.                 Message message = (Message) packet;
  87.                 RosterExchange rosterExchange = (RosterExchange) message.getExtensionElement(ELEMENT, NAMESPACE);
  88.                 // Fire event for roster exchange listeners
  89.                 fireRosterExchangeListeners(message.getFrom(), rosterExchange.getRosterEntries());
  90.             }
  91.         };
  92.         connection.addAsyncStanzaListener(packetListener, PACKET_FILTER);
  93.     }

  95.     /**
  96.      * Adds a listener to roster exchanges. The listener will be fired anytime roster entries
  97.      * are received from remote XMPP clients.
  98.      *
  99.      * @param rosterExchangeListener a roster exchange listener.
  100.      */
  101.     public void addRosterListener(RosterExchangeListener rosterExchangeListener) {
  102.         rosterExchangeListeners.add(rosterExchangeListener);
  103.     }

  105.     /**
  106.      * Removes a listener from roster exchanges. The listener will be fired anytime roster
  107.      * entries are received from remote XMPP clients.
  108.      *
  109.      * @param rosterExchangeListener a roster exchange listener.
  110.      */
  111.     public void removeRosterListener(RosterExchangeListener rosterExchangeListener) {
  112.         rosterExchangeListeners.remove(rosterExchangeListener);
  113.     }

  115.     /**
  116.      * Sends a roster to userID. All the entries of the roster will be sent to the
  117.      * target user.
  118.      *
  119.      * @param roster the roster to send
  120.      * @param targetUserID the user that will receive the roster entries
  121.      * @throws NotConnectedException if the XMPP connection is not connected.
  122.      * @throws InterruptedException if the calling thread was interrupted.
  123.      */
  124.     public void send(Roster roster, Jid targetUserID) throws NotConnectedException, InterruptedException {
  125.         XMPPConnection connection = weakRefConnection.get();

  127.         // Create a new message to send the roster
  128.         MessageBuilder messageBuilder = connection.getStanzaFactory().buildMessageStanza().to(targetUserID);
  129.         // Create a RosterExchange Package and add it to the message
  130.         RosterExchange rosterExchange = new RosterExchange(roster);
  131.         messageBuilder.addExtension(rosterExchange);

  133.         // Send the message that contains the roster
  134.         connection.sendStanza(messageBuilder.build());
  135.     }

  137.     /**
  138.      * Sends a roster entry to userID.
  139.      *
  140.      * @param rosterEntry the roster entry to send
  141.      * @param targetUserID the user that will receive the roster entries
  142.      * @throws NotConnectedException if the XMPP connection is not connected.
  143.      * @throws InterruptedException if the calling thread was interrupted.
  144.      */
  145.     public void send(RosterEntry rosterEntry, Jid targetUserID) throws NotConnectedException, InterruptedException {
  146.         XMPPConnection connection = weakRefConnection.get();

  148.         // Create a new message to send the roster
  149.         MessageBuilder messageBuilder = connection.getStanzaFactory().buildMessageStanza().to(targetUserID);
  150.         // Create a RosterExchange Package and add it to the message
  151.         RosterExchange rosterExchange = new RosterExchange();
  152.         rosterExchange.addRosterEntry(rosterEntry);
  153.         messageBuilder.addExtension(rosterExchange);

  155.         // Send the message that contains the roster
  156.         connection.sendStanza(messageBuilder.build());
  157.     }

  159.     /**
  160.      * Sends a roster group to userID. All the entries of the group will be sent to the
  161.      * target user.
  162.      *
  163.      * @param rosterGroup the roster group to send
  164.      * @param targetUserID the user that will receive the roster entries
  165.      * @throws NotConnectedException if the XMPP connection is not connected.
  166.      * @throws InterruptedException if the calling thread was interrupted.
  167.      */
  168.     public void send(RosterGroup rosterGroup, Jid targetUserID) throws NotConnectedException, InterruptedException {
  169.         XMPPConnection connection = weakRefConnection.get();

  171.         // Create a new message to send the roster
  172.         MessageBuilder msg = connection.getStanzaFactory().buildMessageStanza().to(targetUserID);
  173.         // Create a RosterExchange Package and add it to the message
  174.         RosterExchange rosterExchange = new RosterExchange();
  175.         for (RosterEntry entry : rosterGroup.getEntries()) {
  176.             rosterExchange.addRosterEntry(entry);
  177.         }
  178.         msg.addExtension(rosterExchange);

  180.         // Send the message that contains the roster
  181.         connection.sendStanza(msg.build());
  182.     }

  184.     /**
  185.      * Fires roster exchange listeners.
  186.      */
  187.     private void fireRosterExchangeListeners(Jid from, Iterator<RemoteRosterEntry> remoteRosterEntries) {
  188.         RosterExchangeListener[] listeners;
  189.         synchronized (rosterExchangeListeners) {
  190.             listeners = new RosterExchangeListener[rosterExchangeListeners.size()];
  191.             rosterExchangeListeners.toArray(listeners);
  192.         }
  193.         for (RosterExchangeListener listener : listeners) {
  194.             listener.entriesReceived(from, remoteRosterEntries);
  195.         }
  196.     }
  197. }
Created with JaCoCo 0.8.6.202009150832