Merge pull request igniterealtime#573 from guusdk/OF-1125

OF-1125: Should use StreamID class instead of String.

Author: dwd

src/java/org/jivesoftware/openfire/LocalSessionManager.java

@@ -89,11 +89,11 @@ class LocalSessionManager {
     /**
      * The sessions contained in this Map are server sessions originated by a remote server. These
      * sessions can only receive packets from the remote server but are not capable of sending
-     * packets to the remote server. Sessions will be added to this collecion only after they were
+     * packets to the remote server. Sessions will be added to this collection only after they were
      * authenticated.
      * Key: streamID, Value: the IncomingServerSession associated to the streamID.
      */
-    private final Map<String, LocalIncomingServerSession> incomingServerSessions =
+    private final Map<StreamID, LocalIncomingServerSession> incomingServerSessions =
             new ConcurrentHashMap<>();
 
 
@@ -109,19 +109,19 @@ public Map<String, LocalConnectionMultiplexerSession> getConnnectionManagerSessi
         return connnectionManagerSessions;
     }
 
-    public LocalIncomingServerSession getIncomingServerSession(String streamID) {
+    public LocalIncomingServerSession getIncomingServerSession(StreamID streamID) {
         return incomingServerSessions.get(streamID);
     }
 
     public Collection<LocalIncomingServerSession> getIncomingServerSessions() {
         return incomingServerSessions.values();
     }
 
-    public void addIncomingServerSessions(String streamID, LocalIncomingServerSession  session) {
+    public void addIncomingServerSessions(StreamID streamID, LocalIncomingServerSession  session) {
         incomingServerSessions.put(streamID, session);
     }
 
-    public void removeIncomingServerSessions(String streamID) {
+    public void removeIncomingServerSessions(StreamID streamID) {
         incomingServerSessions.remove(streamID);
     }
 

src/java/org/jivesoftware/openfire/SessionManager.java

@@ -22,34 +22,24 @@
 
 import java.net.InetAddress;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Date;
-import java.util.Deque;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.locks.Lock;
 
-import org.dom4j.Element;
 import org.jivesoftware.openfire.audit.AuditStreamIDFactory;
 import org.jivesoftware.openfire.auth.AuthToken;
 import org.jivesoftware.openfire.auth.UnauthorizedException;
 import org.jivesoftware.openfire.cluster.ClusterEventListener;
 import org.jivesoftware.openfire.cluster.ClusterManager;
 import org.jivesoftware.openfire.component.InternalComponentManager;
 import org.jivesoftware.openfire.container.BasicModule;
-import org.jivesoftware.openfire.disco.DiscoInfoProvider;
-import org.jivesoftware.openfire.disco.DiscoItem;
-import org.jivesoftware.openfire.disco.DiscoItemsProvider;
-import org.jivesoftware.openfire.disco.DiscoServerItem;
-import org.jivesoftware.openfire.disco.ServerItemsProvider;
 import org.jivesoftware.openfire.event.SessionEventDispatcher;
 import org.jivesoftware.openfire.http.HttpConnection;
 import org.jivesoftware.openfire.http.HttpSession;
@@ -70,18 +60,13 @@
 import org.jivesoftware.openfire.session.RemoteSessionLocator;
 import org.jivesoftware.openfire.session.Session;
 import org.jivesoftware.openfire.spi.BasicStreamIDFactory;
-import org.jivesoftware.openfire.streammanagement.StreamManager;
 import org.jivesoftware.openfire.user.UserManager;
-import org.jivesoftware.openfire.user.UserNotFoundException;
 import org.jivesoftware.util.JiveGlobals;
 import org.jivesoftware.util.LocaleUtils;
-import org.jivesoftware.util.Log;
-import org.jivesoftware.util.XMPPDateTimeFormat;
 import org.jivesoftware.util.cache.Cache;
 import org.jivesoftware.util.cache.CacheFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.xmpp.forms.DataForm;
 import org.xmpp.packet.JID;
 import org.xmpp.packet.Message;
 import org.xmpp.packet.Packet;
@@ -145,15 +130,15 @@ public class SessionManager extends BasicModule implements ClusterEventListener/
      * Cache (unlimited, never expire) that holds incoming sessions of remote servers.
      * Key: stream ID that identifies the socket/session, Value: nodeID
      */
-    private Cache<String, byte[]> incomingServerSessionsCache;
+    private Cache<StreamID, byte[]> incomingServerSessionsCache;
     /**
      * Cache (unlimited, never expire) that holds list of incoming sessions
      * originated from the same remote server (domain/subdomain). For instance, jabber.org
      * may have 2 connections to the server running in jivesoftware.com (one socket to
      * jivesoftware.com and the other socket to conference.jivesoftware.com).
      * Key: remote hostname (domain/subdomain), Value: list of stream IDs that identify each socket.
      */
-    private Cache<String, List<String>> hostnameSessionsCache;
+    private Cache<String, List<StreamID>> hostnameSessionsCache;
 
     /**
      * Cache (unlimited, never expire) that holds domains, subdomains and virtual
@@ -167,7 +152,7 @@ public class SessionManager extends BasicModule implements ClusterEventListener/
      * will have access to this clustered cache even in the case of this node going
      * down.
      */
-    private Cache<String, Set<String>> validatedDomainsCache;
+    private Cache<StreamID, Set<String>> validatedDomainsCache;
 
     private ClientSessionListener clientSessionListener = new ClientSessionListener();
     private ComponentSessionListener componentSessionListener = new ComponentSessionListener();
@@ -465,15 +450,15 @@ public void outgoingServerSessionCreated(LocalOutgoingServerSession session) {
      */
     public void registerIncomingServerSession(String hostname, LocalIncomingServerSession session) {
         // Keep local track of the incoming server session connected to this JVM
-        String streamID = session.getStreamID().getID();
+        StreamID streamID = session.getStreamID();
         localSessionManager.addIncomingServerSessions(streamID, session);
         // Keep track of the nodeID hosting the incoming server session
         incomingServerSessionsCache.put(streamID, server.getNodeID().toByteArray());
         // Update list of sockets/sessions coming from the same remote hostname
         Lock lock = CacheFactory.getLock(hostname, hostnameSessionsCache);
         try {
             lock.lock();
-            List<String> streamIDs = hostnameSessionsCache.get(hostname);
+            List<StreamID> streamIDs = hostnameSessionsCache.get(hostname);
             if (streamIDs == null) {
                 streamIDs = new ArrayList<>();
             }
@@ -508,7 +493,7 @@ public void registerIncomingServerSession(String hostname, LocalIncomingServerSe
      */
     public void unregisterIncomingServerSession(String hostname, IncomingServerSession session) {
         // Remove local track of the incoming server session connected to this JVM
-        String streamID = session.getStreamID().getID();
+        StreamID streamID = session.getStreamID();
         localSessionManager.removeIncomingServerSessions(streamID);
         // Remove track of the nodeID hosting the incoming server session
         incomingServerSessionsCache.remove(streamID);
@@ -517,7 +502,7 @@ public void unregisterIncomingServerSession(String hostname, IncomingServerSessi
         Lock lock = CacheFactory.getLock(hostname, hostnameSessionsCache);
         try {
             lock.lock();
-            List<String> streamIDs = hostnameSessionsCache.get(hostname);
+            List<StreamID> streamIDs = hostnameSessionsCache.get(hostname);
             if (streamIDs != null) {
                 streamIDs.remove(streamID);
                 if (streamIDs.isEmpty()) {
@@ -563,7 +548,7 @@ public void unregisterIncomingServerSession(String hostname, IncomingServerSessi
      * @param streamID id that uniquely identifies the session.
      * @return domains, subdomains and virtual hosts that where validated.
      */
-    public Collection<String> getValidatedDomains(String streamID) {
+    public Collection<String> getValidatedDomains(StreamID streamID) {
         Lock lock = CacheFactory.getLock(streamID, validatedDomainsCache);
         try {
             lock.lock();
@@ -850,7 +835,7 @@ public Collection<ClientSession> getSessions(SessionResultFilter filter) {
      * @param streamID the stream ID that identifies the incoming server session hosted by this JVM.
      * @return the incoming server session hosted by this JVM or null if none was found.
      */
-    public LocalIncomingServerSession getIncomingServerSession(String streamID) {
+    public LocalIncomingServerSession getIncomingServerSession(StreamID streamID) {
         return localSessionManager.getIncomingServerSession(streamID);
     }
 
@@ -863,7 +848,7 @@ public LocalIncomingServerSession getIncomingServerSession(String streamID) {
      * @return the sessions that were originated by a remote server.
      */
     public List<IncomingServerSession> getIncomingServerSessions(String hostname) {
-        List<String> streamIDs;
+        List<StreamID> streamIDs;
         // Get list of sockets/sessions coming from the remote hostname
         Lock lock = CacheFactory.getLock(hostname, hostnameSessionsCache);
         try {
@@ -880,7 +865,7 @@ public List<IncomingServerSession> getIncomingServerSessions(String hostname) {
         else {
             // Collect the sessions associated to the found stream IDs
             List<IncomingServerSession> sessions = new ArrayList<>();
-            for (String streamID : streamIDs) {
+            for (StreamID streamID : streamIDs) {
                 // Search in local hosted sessions
                 IncomingServerSession session = localSessionManager.getIncomingServerSession(streamID);
                 RemoteSessionLocator locator = server.getRemoteSessionLocator();
@@ -1608,14 +1593,14 @@ private void restoreCacheContent() {
 
         // Add incoming server sessions hosted locally to the cache (using new nodeID)
         for (LocalIncomingServerSession session : localSessionManager.getIncomingServerSessions()) {
-            String streamID = session.getStreamID().getID();
+            StreamID streamID = session.getStreamID();
             incomingServerSessionsCache.put(streamID, server.getNodeID().toByteArray());
             for (String hostname : session.getValidatedDomains()) {
                 // Update list of sockets/sessions coming from the same remote hostname
                 Lock lock = CacheFactory.getLock(hostname, hostnameSessionsCache);
                 try {
                     lock.lock();
-                    List<String> streamIDs = hostnameSessionsCache.get(hostname);
+                    List<StreamID> streamIDs = hostnameSessionsCache.get(hostname);
                     if (streamIDs == null) {
                         streamIDs = new ArrayList<>();
                     }

src/java/org/jivesoftware/openfire/multiplex/ClientSessionConnection.java

@@ -21,6 +21,7 @@
 package org.jivesoftware.openfire.multiplex;
 
 import org.dom4j.Element;
+import org.jivesoftware.openfire.StreamID;
 import org.jivesoftware.openfire.XMPPServer;
 import org.jivesoftware.openfire.net.VirtualConnection;
 import org.jivesoftware.openfire.session.ConnectionMultiplexerSession;
@@ -72,7 +73,7 @@ public ClientSessionConnection(String connectionManagerName, String hostName, St
      */
     @Override
     public void deliver(Packet packet) {
-        String streamID = session.getStreamID().getID();
+        StreamID streamID = session.getStreamID();
         ConnectionMultiplexerSession multiplexerSession =
                 multiplexerManager.getMultiplexerSession(connectionManagerName,streamID);
         if (multiplexerSession != null) {
@@ -100,15 +101,15 @@ public void deliver(Packet packet) {
      */
     @Override
     public void deliverRawText(String text) {
-        String streamID = session.getStreamID().getID();
+        StreamID streamID = session.getStreamID();
         ConnectionMultiplexerSession multiplexerSession =
                 multiplexerManager.getMultiplexerSession(connectionManagerName,streamID);
         if (multiplexerSession != null) {
             // Wrap packet so that the connection manager can figure out the target session
             StringBuilder sb = new StringBuilder(200 + text.length());
             sb.append("<route from=\"").append(serverName);
             sb.append("\" to=\"").append(connectionManagerName);
-            sb.append("\" streamid=\"").append(streamID).append("\">");
+            sb.append("\" streamid=\"").append(streamID.getID()).append("\">");
             sb.append(text);
             sb.append("</route>");
             // Deliver the wrapped stanza
@@ -176,7 +177,7 @@ public void systemShutdown() {
     @Override
 	public void closeVirtualConnection() {
         // Figure out who requested the connection to be closed
-        String streamID = session.getStreamID().getID();
+        StreamID streamID = session.getStreamID();
         if (multiplexerManager.getClientSession(connectionManagerName, streamID) == null) {
             // Client or Connection manager requested to close the session
             // Do nothing since it has already been removed and closed
@@ -192,7 +193,7 @@ public void closeVirtualConnection() {
                 closeRequest.setTo(connectionManagerName);
                 Element child = closeRequest.setChildElement("session",
                         "http://jabber.org/protocol/connectionmanager");
-                child.addAttribute("id", streamID);
+                child.addAttribute("id", streamID.getID());
                 child.addElement("close");
                 multiplexerSession.process(closeRequest);
             }