org.jivesoftware.smackx.search

Class UserSearch

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smack.packet.SimpleIQ

org.jivesoftware.smackx.search.UserSearch

All Implemented Interfaces:

Element, TopLevelStreamElement

public class UserSearch
extends SimpleIQ

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). However, the jabber:iq:search protocol is not limited to user directories, and could be used to search other Jabber information repositories (such as chatroom directories) or even to provide a Jabber interface to conventional search engines. The basic functionality is to query an information repository regarding the possible search fields, to send a search query, and to receive search results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSearch.Provider Internal Search service Provider.

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
UserSearch() Creates a new instance of UserSearch.

Method Summary

Modifier and Type	Method and Description
Form	getSearchForm(XMPPConnection con, org.jxmpp.jid.DomainBareJid searchService) Returns the form for all search fields supported by the search service.
ReportedData	sendSearchForm(XMPPConnection con, Form searchForm, org.jxmpp.jid.DomainBareJid searchService) Sends the filled out answer form to be sent and queried by the search service.
ReportedData	sendSimpleSearchForm(XMPPConnection con, Form searchForm, org.jxmpp.jid.DomainBareJid searchService) Sends the filled out answer form to be sent and queried by the search service.

Methods inherited from class org.jivesoftware.smack.packet.SimpleIQ

getIQChildElementBuilder

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setFrom, setLanguage, setPacketID, setStanzaId, setStanzaId, setTo, setTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

UserSearch

public UserSearch()

Creates a new instance of UserSearch.

Method Detail

getSearchForm

public Form getSearchForm(XMPPConnection con,
                          org.jxmpp.jid.DomainBareJid searchService)
                   throws SmackException.NoResponseException,
                          XMPPException.XMPPErrorException,
                          SmackException.NotConnectedException,
                          java.lang.InterruptedException

Returns the form for all search fields supported by the search service.

Parameters:

con - the current XMPPConnection.

searchService - the search service to use. (ex. search.jivesoftware.com)

Returns:

the search form received by the server.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

java.lang.InterruptedException

sendSearchForm

public ReportedData sendSearchForm(XMPPConnection con,
                                   Form searchForm,
                                   org.jxmpp.jid.DomainBareJid searchService)
                            throws SmackException.NoResponseException,
                                   XMPPException.XMPPErrorException,
                                   SmackException.NotConnectedException,
                                   java.lang.InterruptedException

Sends the filled out answer form to be sent and queried by the search service.

Parameters:

con - the current XMPPConnection.

searchForm - the Form to send for querying.

searchService - the search service to use. (ex. search.jivesoftware.com)

Returns:

ReportedData the data found from the query.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

java.lang.InterruptedException

sendSimpleSearchForm

public ReportedData sendSimpleSearchForm(XMPPConnection con,
                                         Form searchForm,
                                         org.jxmpp.jid.DomainBareJid searchService)
                                  throws SmackException.NoResponseException,
                                         XMPPException.XMPPErrorException,
                                         SmackException.NotConnectedException,
                                         java.lang.InterruptedException

Sends the filled out answer form to be sent and queried by the search service.

Parameters:

con - the current XMPPConnection.

searchForm - the Form to send for querying.

searchService - the search service to use. (ex. search.jivesoftware.com)

Returns:

ReportedData the data found from the query.

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

java.lang.InterruptedException