[search] Overhaul UserSearchManager and add integration test

Author: Flowdalic

smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java

@@ -18,10 +18,6 @@
 
 import java.io.IOException;
 
-import org.jivesoftware.smack.SmackException.NoResponseException;
-import org.jivesoftware.smack.SmackException.NotConnectedException;
-import org.jivesoftware.smack.XMPPConnection;
-import org.jivesoftware.smack.XMPPException.XMPPErrorException;
 import org.jivesoftware.smack.packet.IQ;
 import org.jivesoftware.smack.packet.IqData;
 import org.jivesoftware.smack.packet.SimpleIQ;
@@ -32,10 +28,6 @@
 import org.jivesoftware.smack.xml.XmlPullParser;
 import org.jivesoftware.smack.xml.XmlPullParserException;
 
-import org.jivesoftware.smackx.xdata.packet.DataForm;
-
-import org.jxmpp.jid.DomainBareJid;
-
 /**
  * Implements the protocol currently used to search information repositories on the Jabber network. To date, the jabber:iq:search protocol
  * has been used mainly to search for people who have registered with user directories (e.g., the "Jabber User Directory" hosted at users.jabber.org).
@@ -58,70 +50,6 @@ public UserSearch() {
         super(ELEMENT, NAMESPACE);
     }
 
-    /**
-     * Returns the form for all search fields supported by the search service.
-     *
-     * @param con           the current XMPPConnection.
-     * @param searchService the search service to use. (ex. search.jivesoftware.com)
-     * @return the search form received by the server.
-     * @throws XMPPErrorException if there was an XMPP error returned.
-     * @throws NoResponseException if there was no response from the remote entity.
-     * @throws NotConnectedException if the XMPP connection is not connected.
-     * @throws InterruptedException if the calling thread was interrupted.
-     */
-    public DataForm getSearchForm(XMPPConnection con, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
-        UserSearch search = new UserSearch();
-        search.setType(IQ.Type.get);
-        search.setTo(searchService);
-
-        IQ response = con.sendIqRequestAndWaitForResponse(search);
-        return DataForm.from(response, NAMESPACE);
-    }
-
-    /**
-     * Sends the filled out answer form to be sent and queried by the search service.
-     *
-     * @param con           the current XMPPConnection.
-     * @param searchForm    the <code>Form</code> to send for querying.
-     * @param searchService the search service to use. (ex. search.jivesoftware.com)
-     * @return ReportedData the data found from the query.
-     * @throws XMPPErrorException if there was an XMPP error returned.
-     * @throws NoResponseException if there was no response from the remote entity.
-     * @throws NotConnectedException if the XMPP connection is not connected.
-     * @throws InterruptedException if the calling thread was interrupted.
-     */
-    public ReportedData sendSearchForm(XMPPConnection con, DataForm searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
-        UserSearch search = new UserSearch();
-        search.setType(IQ.Type.set);
-        search.setTo(searchService);
-        search.addExtension(searchForm);
-
-        IQ response = con.sendIqRequestAndWaitForResponse(search);
-        return ReportedData.getReportedDataFrom(response);
-    }
-
-    /**
-     * Sends the filled out answer form to be sent and queried by the search service.
-     *
-     * @param con           the current XMPPConnection.
-     * @param searchForm    the <code>Form</code> to send for querying.
-     * @param searchService the search service to use. (ex. search.jivesoftware.com)
-     * @return ReportedData the data found from the query.
-     * @throws XMPPErrorException if there was an XMPP error returned.
-     * @throws NoResponseException if there was no response from the remote entity.
-     * @throws NotConnectedException if the XMPP connection is not connected.
-     * @throws InterruptedException if the calling thread was interrupted.
-     */
-    public ReportedData sendSimpleSearchForm(XMPPConnection con, DataForm searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
-        SimpleUserSearch search = new SimpleUserSearch();
-        search.setForm(searchForm);
-        search.setType(IQ.Type.set);
-        search.setTo(searchService);
-
-        SimpleUserSearch response = con.sendIqRequestAndWaitForResponse(search);
-        return response.getReportedData();
-    }
-
     /**
      * Internal Search service Provider.
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java

@@ -1,6 +1,6 @@
 /**
  *
- * Copyright 2003-2007 Jive Software.
+ * Copyright 2003-2007 Jive Software, 2025 Florian Schmaus.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,11 +17,15 @@
 package org.jivesoftware.smackx.search;
 
 import java.util.List;
+import java.util.Map;
+import java.util.WeakHashMap;
 
+import org.jivesoftware.smack.Manager;
 import org.jivesoftware.smack.SmackException.NoResponseException;
 import org.jivesoftware.smack.SmackException.NotConnectedException;
 import org.jivesoftware.smack.XMPPConnection;
 import org.jivesoftware.smack.XMPPException.XMPPErrorException;
+import org.jivesoftware.smack.packet.IQ;
 
 import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
 import org.jivesoftware.smackx.xdata.form.FillableForm;
@@ -36,32 +40,40 @@
  * searching (DataForms or No DataForms), but allows the user to simply use the DataForm model for both
  * types of support.
  * <pre>
- * XMPPConnection con = new XMPPTCPConnection("jabber.org");
- * con.login("john", "doe");
- * UserSearchManager search = new UserSearchManager(con, "users.jabber.org");
- * Form searchForm = search.getSearchForm();
- * FillableForm answerForm = searchForm.getFillableForm()
- * // Fill out the form.
- * answerForm.setAnswer("last", "DeMoro");
- * ReportedData data = search.getSearchResults(answerForm);
- * // Use Returned Data
+ * XMPPConnection connection = …;
+ * var searchService = UserSearchManager.getSearchServices(connection).get(0);
+ * var searchManager = UserSearchManager.getInstanceFor(connection);
+ * var sarchForm = searchManager.getSearchForm(searchService);
+ * var fillableForm = searchForm.getFillableForm();
+ *
+ * // Check for the required fields in the form and fill them
+ * fillableForm.setAnswer("search", "John");
+ *
+ * var results = searchOne.search(fillableForm, userSearchService);
+ * // Use results
  * </pre>
  *
  * @author Derek DeMoro
  */
-public class UserSearchManager {
+public final class UserSearchManager extends Manager {
 
-    private final XMPPConnection con;
-    private final UserSearch userSearch;
+    private static final Map<XMPPConnection, UserSearchManager> INSTANCES = new WeakHashMap<>();
 
+    public static synchronized UserSearchManager getInstanceFor(XMPPConnection connection) {
+        var userSearchManager = INSTANCES.get(connection);
+        if (userSearchManager == null) {
+            userSearchManager = new UserSearchManager(connection);
+            INSTANCES.put(connection, userSearchManager);
+        }
+        return userSearchManager;
+    }
     /**
      * Creates a new UserSearchManager.
      *
-     * @param con the XMPPConnection to use.
+     * @param connection the XMPPConnection to use.
      */
-    public UserSearchManager(XMPPConnection con) {
-        this.con = con;
-        userSearch = new UserSearch();
+    private UserSearchManager(XMPPConnection connection) {
+        super(connection);
     }
 
     /**
@@ -75,39 +87,70 @@ public UserSearchManager(XMPPConnection con) {
      * @throws InterruptedException if the calling thread was interrupted.
      */
     public Form getSearchForm(DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException  {
-        DataForm dataForm = userSearch.getSearchForm(con, searchService);
+        UserSearch search = new UserSearch();
+        search.setType(IQ.Type.get);
+        search.setTo(searchService);
+
+        IQ response = connection().sendIqRequestAndWaitForResponse(search);
+        var dataForm = DataForm.from(response, UserSearch.NAMESPACE);
         return new Form(dataForm);
     }
 
     /**
-     * Submits a search form to the server and returns the resulting information
-     * in the form of <code>ReportedData</code>.
+     * Sends the filled out answer form to be sent and queried by the search service.
      *
-     * @param searchForm    the <code>Form</code> to submit for searching.
-     * @param searchService the name of the search service to use.
-     * @return the ReportedData returned by the server.
+     * @param filledForm    the filled form with the query instructions.
+     * @param searchService the search service to use. (ex. search.jivesoftware.com)
+     * @return ReportedData the data found from the query.
      * @throws XMPPErrorException if there was an XMPP error returned.
      * @throws NoResponseException if there was no response from the remote entity.
      * @throws NotConnectedException if the XMPP connection is not connected.
      * @throws InterruptedException if the calling thread was interrupted.
      */
-    public ReportedData getSearchResults(FillableForm searchForm, DomainBareJid searchService)
+    public ReportedData search(FillableForm filledForm, DomainBareJid searchService)
                     throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
-        DataForm dataForm = searchForm.getDataFormToSubmit();
-        return userSearch.sendSearchForm(con, dataForm, searchService);
+        UserSearch search = new UserSearch();
+        search.setType(IQ.Type.set);
+        search.setTo(searchService);
+        search.addExtension(filledForm.getDataFormToSubmit());
+
+        IQ response = connection().sendIqRequestAndWaitForResponse(search);
+        return ReportedData.getReportedDataFrom(response);
+    }
+
+    /**
+     * Sends the filled out answer form to be sent and queried by the search service.
+     *
+     * @param searchForm    the <code>Form</code> to send for querying.
+     * @param searchService the search service to use. (ex. search.jivesoftware.com)
+     * @return ReportedData the data found from the query.
+     * @throws XMPPErrorException if there was an XMPP error returned.
+     * @throws NoResponseException if there was no response from the remote entity.
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws InterruptedException if the calling thread was interrupted.
+     */
+    public ReportedData sendSimpleSearchForm(DataForm searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        SimpleUserSearch search = new SimpleUserSearch();
+        search.setForm(searchForm);
+        search.setType(IQ.Type.set);
+        search.setTo(searchService);
+
+        SimpleUserSearch response = connection().sendIqRequestAndWaitForResponse(search);
+        return response.getReportedData();
     }
 
     /**
      * Returns a collection of search services found on the server.
      *
+     * @param connection the connection to query for search services.
      * @return a Collection of search services found on the server.
      * @throws XMPPErrorException if there was an XMPP error returned.
      * @throws NoResponseException if there was no response from the remote entity.
      * @throws NotConnectedException if the XMPP connection is not connected.
      * @throws InterruptedException if the calling thread was interrupted.
      */
-    public List<DomainBareJid> getSearchServices() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException  {
-        ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(con);
-        return discoManager.findServices(UserSearch.NAMESPACE, false, false);
+    public static List<DomainBareJid> getSearchServices(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException  {
+        ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection);
+        return discoManager.findServices(UserSearch.NAMESPACE, false, true);
     }
 }

smack-integration-test/src/main/java/org/jivesoftware/smackx/search/UserSearchManagerIntegrationTest.java

@@ -0,0 +1,65 @@
+/**
+ *
+ * Copyright 2025 Florian Schmaus
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+package org.jivesoftware.smackx.search;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import org.jivesoftware.smack.SmackException.NoResponseException;
+import org.jivesoftware.smack.SmackException.NotConnectedException;
+import org.jivesoftware.smack.XMPPException.XMPPErrorException;
+
+import org.igniterealtime.smack.inttest.AbstractSmackIntegrationTest;
+import org.igniterealtime.smack.inttest.SmackIntegrationTestEnvironment;
+import org.igniterealtime.smack.inttest.TestNotPossibleException;
+import org.igniterealtime.smack.inttest.annotations.SmackIntegrationTest;
+
+import org.jxmpp.jid.DomainBareJid;
+
+public class UserSearchManagerIntegrationTest extends AbstractSmackIntegrationTest {
+
+    private final DomainBareJid userSearchService;
+
+    private final UserSearchManager searchOne;
+
+    public UserSearchManagerIntegrationTest(SmackIntegrationTestEnvironment environment) throws NoResponseException,
+                    XMPPErrorException, NotConnectedException, InterruptedException, TestNotPossibleException {
+        super(environment);
+
+        var searchServices = UserSearchManager.getSearchServices(conOne);
+        if (searchServices.isEmpty()) {
+            throw new TestNotPossibleException("No user seearch services (XEP-0055) found");
+        }
+
+        // Since we are only performing a very primitive test, where we don't expect actual results from the service,
+        // using any of the returned services should be fine.
+        userSearchService = searchServices.get(0);
+
+        searchOne = UserSearchManager.getInstanceFor(conOne);
+    }
+
+    @SmackIntegrationTest
+    public void simple() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        var searchForm = searchOne.getSearchForm(userSearchService);
+        var fillableForm = searchForm.getFillableForm();
+        for (var r : fillableForm.getMissingRequiredFields()) {
+            fillableForm.setAnswer(r, "sinttest");
+        }
+
+        var reportedData = searchOne.search(fillableForm, userSearchService);
+        assertNotNull(reportedData);
+    }
+}

smack-integration-test/src/main/java/org/jivesoftware/smackx/search/package-info.java

@@ -0,0 +1 @@
+../../../../../../../../smack-extensions/src/main/java/org/jivesoftware/smackx/search/package-info.java