OF-1496: Store providers, rather than their provided data.

src/java/org/jivesoftware/openfire/disco/IQDiscoInfoHandler.java

@@ -69,26 +69,42 @@ public class IQDiscoInfoHandler extends IQHandler implements ClusterEventListene
     private Map<String, DiscoInfoProvider> entities = new HashMap<>();
     private Set<String> localServerFeatures = new CopyOnWriteArraySet<>();
     private Cache<String, Set<NodeID>> serverFeatures;
-    private List<Element> serverIdentities = new ArrayList<>();
+    private List<ServerIdentitiesProvider> serverIdentityProviders = new ArrayList<>();
     private Map<String, DiscoInfoProvider> serverNodeProviders = new ConcurrentHashMap<>();
     private IQHandlerInfo info;
 
-    private List<Element> anonymousUserIdentities = new ArrayList<>();
-    private List<Element> registeredUserIdentities = new ArrayList<>();
+    private List<UserIdentitiesProvider> anonymousUserIdentityProviders = new ArrayList<>();
+    private List<UserIdentitiesProvider> registeredUserIdentityProviders = new ArrayList<>();
 
     public IQDiscoInfoHandler() {
         super("XMPP Disco Info Handler");
         info = new IQHandlerInfo("query", NAMESPACE_DISCO_INFO);
-        // Initialize the user identity and features collections (optimization to avoid creating
-        // the same objects for each response)
-        Element userIdentity = DocumentHelper.createElement("identity");
-        userIdentity.addAttribute("category", "account");
-        userIdentity.addAttribute("type", "anonymous");
-        anonymousUserIdentities.add(userIdentity);
-        userIdentity = DocumentHelper.createElement("identity");
-        userIdentity.addAttribute("category", "account");
-        userIdentity.addAttribute("type", "registered");
-        registeredUserIdentities.add(userIdentity);
+
+        anonymousUserIdentityProviders.add( new UserIdentitiesProvider()
+        {
+            @Override
+            public Iterator<Element> getIdentities()
+            {
+                final Element userIdentity = DocumentHelper.createElement( "identity" );
+                userIdentity.addAttribute( "category", "account" );
+                userIdentity.addAttribute( "type", "anonymous" );
+
+                return Collections.singleton( userIdentity ).iterator();
+            }
+        } );
+
+        registeredUserIdentityProviders.add( new UserIdentitiesProvider()
+        {
+            @Override
+            public Iterator<Element> getIdentities()
+            {
+                final Element userIdentity = DocumentHelper.createElement( "identity" );
+                userIdentity.addAttribute( "category", "account" );
+                userIdentity.addAttribute( "type", "registered" );
+
+                return Collections.singleton( userIdentity ).iterator();
+            }
+        } );
     }
 
     @Override
@@ -258,27 +274,56 @@ public class IQDiscoInfoHandler extends IQHandler implements ClusterEventListene
     }
 
     /**
-     * Adds the "discoverable" identities provided by the provider. This information will be used whenever a disco for
-     * info is made against the server.
+     * Adds the "discoverable" identities provided by the provider whenever a disco for info is made against the server.
      *
      * @param provider The provider of identities.
      */
     public void addServerIdentitiesProvider(ServerIdentitiesProvider provider) {
-        for (Iterator<Element> it = provider.getIdentities(); it.hasNext();) {
-            serverIdentities.add(it.next());
+        if ( provider == null )
+        {
+            throw new NullPointerException( "Argument 'provider' cannot be null." );
         }
+        serverIdentityProviders.add( provider );
     }
 
     /**
-     * Adds the "discoverable" user identities provided by the provider. This information will be used whenever a disco
-     * for info is made against users of the server.
+     * Removes this provider of identities.
+     *
+     * @param provider The provider of identities.
+     */
+    public void removeServerIdentitiesProvider(ServerIdentitiesProvider provider) {
+        if ( provider == null )
+        {
+            throw new NullPointerException( "Argument 'provider' cannot be null." );
+        }
+        serverIdentityProviders.remove( provider );
+    }
+
+    /**
+     * Adds the "discoverable" user identities provided by the provider whenever a disco for info is made against users
+     * of the server.
      *
      * @param provider The provider of user identities.
      */
     public void addUserIdentitiesProvider(UserIdentitiesProvider provider) {
-        for (Iterator<Element> it = provider.getIdentities(); it.hasNext();) {
-            registeredUserIdentities.add( it.next() );
+        if ( provider == null )
+        {
+            throw new NullPointerException( "Argument 'provider' cannot be null." );
         }
+        registeredUserIdentityProviders.add( provider );
+    }
+
+    /**
+     * Removes this provider of user identities.
+     *
+     * @param provider The provider of identities.
+     */
+    public void removeUserIdentitiesProvider(UserIdentitiesProvider provider) {
+        if ( provider == null )
+        {
+            throw new NullPointerException( "Argument 'provider' cannot be null." );
+        }
+        registeredUserIdentityProviders.remove( provider );
     }
 
     /**
@@ -419,7 +464,6 @@ public class IQDiscoInfoHandler extends IQHandler implements ClusterEventListene
      */
     private DiscoInfoProvider getServerInfoProvider() {
         return new DiscoInfoProvider() {
-            final ArrayList<Element> identities = new ArrayList<>();
 
             @Override
             public Iterator<Element> getIdentities(String name, String node, JID senderJID) {
@@ -429,20 +473,20 @@ public class IQDiscoInfoHandler extends IQHandler implements ClusterEventListene
                 }
                 if (name == null || name.equals(XMPPServer.getInstance().getServerInfo().getXMPPDomain())) {
                     // Answer identity of the server
-                    synchronized (identities) {
-                        if (identities.isEmpty()) {
-                            Element identity = DocumentHelper.createElement("identity");
-                            identity.addAttribute("category", "server");
-                            identity.addAttribute("name", JiveGlobals.getProperty(
-                                    "xmpp.server.name", "Openfire Server"));
-                            identity.addAttribute("type", "im");
-
-                            identities.add(identity);
-                            
-                            // Include identities from modules that implement ServerIdentitiesProvider
-                            for (Element identityElement : serverIdentities) {
-                                identities.add(identityElement);
-                            }
+                    final ArrayList<Element> identities = new ArrayList<>();
+                    final Element identity = DocumentHelper.createElement("identity");
+                    identity.addAttribute("category", "server");
+                    identity.addAttribute("name", JiveGlobals.getProperty("xmpp.server.name", "Openfire Server"));
+                    identity.addAttribute("type", "im");
+                    identities.add(identity);
+
+                    // Include identities from modules that implement ServerIdentitiesProvider
+                    for (ServerIdentitiesProvider provider : serverIdentityProviders )
+                    {
+                        final Iterator<Element> iterator = provider.getIdentities();
+                        while ( iterator.hasNext() )
+                        {
+                            identities.add( iterator.next() );
                         }
                     }
                     return identities.iterator();
@@ -453,12 +497,30 @@ public class IQDiscoInfoHandler extends IQHandler implements ClusterEventListene
                 else {
                     if (SessionManager.getInstance().isAnonymousRoute(name)) {
                         // Answer identity of an anonymous user.
-                        return anonymousUserIdentities.iterator();
+                        final Set<Element> result = new HashSet<>();
+                        for ( final UserIdentitiesProvider provider : anonymousUserIdentityProviders )
+                        {
+                            final Iterator<Element> identities = provider.getIdentities();
+                            while ( identities.hasNext() )
+                            {
+                                result.add( identities.next() );
+                            }
+                        }
+                        return result.iterator();
                     }
                     else {
                         // Answer identity of a registered user.
                         // Note: We know that this user exists because #hasInfo returned true
-                        return registeredUserIdentities.iterator();
+                        final Set<Element> result = new HashSet<>();
+                        for ( final UserIdentitiesProvider provider : registeredUserIdentityProviders )
+                        {
+                            final Iterator<Element> identities = provider.getIdentities();
+                            while ( identities.hasNext() )
+                            {
+                                result.add( identities.next() );
+                            }
+                        }
+                        return result.iterator();
                     }
                 }
             }