UserSearchManager.java
- /**
- *
- * Copyright 2003-2007 Jive Software.
- *
- * 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 java.util.List;
- 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.smackx.disco.ServiceDiscoveryManager;
- import org.jivesoftware.smackx.xdata.form.FillableForm;
- import org.jivesoftware.smackx.xdata.form.Form;
- import org.jivesoftware.smackx.xdata.packet.DataForm;
- import org.jxmpp.jid.DomainBareJid;
- /**
- * The UserSearchManager is a facade built upon Jabber Search Services (XEP-055) to allow for searching
- * repositories on a Jabber Server. This implementation allows for transparency of implementation of
- * 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
- * </pre>
- *
- * @author Derek DeMoro
- */
- public class UserSearchManager {
- private final XMPPConnection con;
- private final UserSearch userSearch;
- /**
- * Creates a new UserSearchManager.
- *
- * @param con the XMPPConnection to use.
- */
- public UserSearchManager(XMPPConnection con) {
- this.con = con;
- userSearch = new UserSearch();
- }
- /**
- * Returns the form to fill out to perform a search.
- *
- * @param searchService the search service to query.
- * @return the form to fill out to perform a search.
- * @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 Form getSearchForm(DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
- DataForm dataForm = userSearch.getSearchForm(con, searchService);
- return new Form(dataForm);
- }
- /**
- * Submits a search form to the server and returns the resulting information
- * in the form of <code>ReportedData</code>.
- *
- * @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.
- * @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)
- throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
- DataForm dataForm = searchForm.getDataFormToSubmit();
- return userSearch.sendSearchForm(con, dataForm, searchService);
- }
- /**
- * Returns a collection of search services found on the server.
- *
- * @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);
- }
- }