iqdiscoitemshandler.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/handler/IQHandler.html#handleIQ(org.xmpp.packet.IQ)">IQHandler</A></CODE></B></DD>
<DD>Handles the received IQ packet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/handler/IQHandler.html#handleIQ(org.xmpp.packet.IQ)">handleIQ</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/handler/IQHandler.html" title="class in org.jivesoftware.openfire.handler">IQHandler</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - the IQ packet to handle.
<DT><B>Returns:</B><DD>the response to send back.</DL>
</DD>
</DL>
<HR>

<A NAME="setProvider(java.lang.String, org.jivesoftware.openfire.disco.DiscoItemsProvider)"><!-- --></A><H3>
setProvider</H3>
<PRE>
protected void <B>setProvider</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                           <A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoItemsProvider</A>&nbsp;provider)</PRE>
<DL>
<DD>Sets that a given DiscoItemsProvider will provide the items related to a given entity. This
 message must be used when new modules (e.g. MUC) are implemented and need to provide
 the items related to them.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the entity.<DD><CODE>provider</CODE> - the DiscoItemsProvider that will provide the entity's items.</DL>
</DD>
</DL>
<HR>

<A NAME="removeProvider(java.lang.String)"><!-- --></A><H3>
removeProvider</H3>
<PRE>
protected void <B>removeProvider</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Removes the DiscoItemsProvider related to a given entity.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the entity.</DL>
</DD>
</DL>
<HR>

<A NAME="addServerItemsProvider(org.jivesoftware.openfire.disco.ServerItemsProvider)"><!-- --></A><H3>
addServerItemsProvider</H3>
<PRE>
public void <B>addServerItemsProvider</B>(<A HREF="../../../../org/jivesoftware/openfire/disco/ServerItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">ServerItemsProvider</A>&nbsp;provider)</PRE>
<DL>
<DD>Adds the items provided by the new service that implements the ServerItemsProvider
 interface. This information will be used whenever a disco for items is made against
 the server (i.e. the packet's target is the server).
 Example of item is: &lt;item jid='conference.localhost' name='Public chatrooms'/&gt;
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - the ServerItemsProvider that provides new server items.</DL>
</DD>
</DL>
<HR>

<A NAME="removeServerItemsProvider(org.jivesoftware.openfire.disco.ServerItemsProvider)"><!-- --></A><H3>
removeServerItemsProvider</H3>
<PRE>
public void <B>removeServerItemsProvider</B>(<A HREF="../../../../org/jivesoftware/openfire/disco/ServerItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">ServerItemsProvider</A>&nbsp;provider)</PRE>
<DL>
<DD>Removes the provided items as a service of the service.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - The provider that is being removed.</DL>
</DD>
</DL>
<HR>

<A NAME="setServerNodeInfoProvider(java.lang.String, org.jivesoftware.openfire.disco.DiscoItemsProvider)"><!-- --></A><H3>
setServerNodeInfoProvider</H3>
<PRE>
public void <B>setServerNodeInfoProvider</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;node,
                                      <A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoItemsProvider</A>&nbsp;provider)</PRE>
<DL>
<DD>Sets the DiscoItemsProvider to use when a disco#items packet is sent to the server itself
 and the specified node. For instance, if node matches "http://jabber.org/protocol/offline"
 then a special DiscoItemsProvider should be use to return information about offline messages.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that the provider will handle.<DD><CODE>provider</CODE> - the DiscoItemsProvider that will handle disco#items packets sent with the
        specified node.</DL>
</DD>
</DL>
<HR>

<A NAME="removeServerNodeInfoProvider(java.lang.String)"><!-- --></A><H3>
removeServerNodeInfoProvider</H3>
<PRE>
public void <B>removeServerNodeInfoProvider</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;node)</PRE>
<DL>
<DD>Removes the DiscoItemsProvider to use when a disco#items packet is sent to the server itself
 and the specified node.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that the provider was handling.</DL>
</DD>
</DL>
<HR>

<A NAME="addComponentItem(java.lang.String, java.lang.String)"><!-- --></A><H3>
addComponentItem</H3>
<PRE>
public void <B>addComponentItem</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;jid,
                             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Registers a new disco item for a component. The jid attribute of the item will match the jid
 of the component and the name should be the name of the component discovered using disco.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the jid of the component.<DD><CODE>name</CODE> - the discovered name of the component.</DL>
</DD>
</DL>
<HR>

<A NAME="addComponentItem(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
addComponentItem</H3>
<PRE>
public void <B>addComponentItem</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;jid,
                             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;node,
                             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Registers a new disco item for a component. The jid attribute of the item will match the jid
 of the component and the name should be the name of the component discovered using disco.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the jid of the component.<DD><CODE>node</CODE> - the node that complements the jid address.<DD><CODE>name</CODE> - the discovered name of the component.</DL>
</DD>
</DL>
<HR>

<A NAME="removeComponentItem(java.lang.String)"><!-- --></A><H3>
removeComponentItem</H3>
<PRE>
public void <B>removeComponentItem</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;jid)</PRE>
<DL>
<DD>Removes a disco item for a component that has been removed from the server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the jid of the component being removed.</DL>
</DD>
</DL>
<HR>

<A NAME="initialize(org.jivesoftware.openfire.XMPPServer)"><!-- --></A><H3>
initialize</H3>
<PRE>
public void <B>initialize</B>(<A HREF="../../../../org/jivesoftware/openfire/XMPPServer.html" title="class in org.jivesoftware.openfire">XMPPServer</A>&nbsp;server)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#initialize(org.jivesoftware.openfire.XMPPServer)">BasicModule</A></CODE></B></DD>
<DD><p>Initializes the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this initialize() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/handler/IQHandler.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/handler/IQHandler.html" title="class in org.jivesoftware.openfire.handler">IQHandler</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>server</CODE> - the server hosting this module.</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()
           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">BasicModule</A></CODE></B></DD>
<DD><p>Starts the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this start() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">start</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - If start is called before initialize
                               successfully returns</DL>
</DD>
</DL>
<HR>

<A NAME="getFeatures()"><!-- --></A><H3>
getFeatures</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt; <B>getFeatures</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerFeaturesProvider.html#getFeatures()">ServerFeaturesProvider</A></CODE></B></DD>
<DD>Returns an Iterator (of String) with the supported features by the server. The features to
 include are the features offered and supported protocols by the SERVER. The idea is that
 different modules may provide their features that will ultimately be part of the features
 offered by the server.