iqpephandler.html

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

<DD>Returns the knownRemotePresences map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the knownRemotePresences map</DL>
</DD>
</DL>
<HR>

<A NAME="handleIQ(org.xmpp.packet.IQ)"><!-- --></A><H3>
handleIQ</H3>
<PRE>
public <A HREF="../../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A> <B>handleIQ</B>(<A HREF="../../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;packet)
            throws <A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<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.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE> - if the user that sent the packet is not
      authorized to request the given operation.</DL>
</DD>
</DL>
<HR>

<A NAME="getPEPService(java.lang.String)"><!-- --></A><H3>
getPEPService</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pep/PEPService.html" title="class in org.jivesoftware.openfire.pep">PEPService</A> <B>getPEPService</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>Retrieves a PEP service -- attempting first from memory, then from the database. Note
 that if no PEP service was found the next request of the PEP service will hit the
 database since we are not caching 'no PEP services'.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the bare JID of the user that owns the PEP service.
<DT><B>Returns:</B><DD>the requested PEP service if found or null if not found.</DL>
</DD>
</DL>
<HR>

<A NAME="getIdentities()"><!-- --></A><H3>
getIdentities</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;org.dom4j.Element&gt; <B>getIdentities</B>()</PRE>
<DL>
<DD>Implements ServerIdentitiesProvider and UserIdentitiesProvider, adding
 the PEP identity to the respective disco#info results.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerIdentitiesProvider.html#getIdentities()">getIdentities</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerIdentitiesProvider.html" title="interface in org.jivesoftware.openfire.disco">ServerIdentitiesProvider</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/UserIdentitiesProvider.html#getIdentities()">getIdentities</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/UserIdentitiesProvider.html" title="interface in org.jivesoftware.openfire.disco">UserIdentitiesProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator (of Element) with identities of protocols supported by the server.</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>Implements ServerFeaturesProvider to include all supported XEP-0060 features
 in the server's disco#info result (as per section 4 of XEP-0163).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerFeaturesProvider.html#getFeatures()">getFeatures</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerFeaturesProvider.html" title="interface in org.jivesoftware.openfire.disco">ServerFeaturesProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator (of String) with the supported features by the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getUserItems(java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getUserItems</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;org.dom4j.Element&gt; <B>getUserItems</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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD>Implements UserItemsProvider, adding PEP related items to a disco#items
 result.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/UserItemsProvider.html#getUserItems(java.lang.String, org.xmpp.packet.JID)">getUserItems</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/UserItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">UserItemsProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco items request.
<DT><B>Returns:</B><DD>an Iterator (of Element) with the target entity's items or null if none.</DL>
</DD>
</DL>
<HR>

<A NAME="subscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
subscribedToPresence</H3>
<PRE>
public void <B>subscribedToPresence</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;subscriberJID,
                                 <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;authorizerJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#subscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)">PresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a user has successfully subscribed
 to the presence of another user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#subscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)">subscribedToPresence</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html" title="interface in org.jivesoftware.openfire.user">PresenceEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subscriberJID</CODE> - the user that initiated the subscription.<DD><CODE>authorizerJID</CODE> - the user that authorized the subscription.</DL>
</DD>
</DL>
<HR>

<A NAME="unsubscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
unsubscribedToPresence</H3>
<PRE>
public void <B>unsubscribedToPresence</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;unsubscriberJID,
                                   <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;recipientJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#unsubscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)">PresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a user has unsubscribed
 to the presence of another user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#unsubscribedToPresence(org.xmpp.packet.JID, org.xmpp.packet.JID)">unsubscribedToPresence</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html" title="interface in org.jivesoftware.openfire.user">PresenceEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>unsubscriberJID</CODE> - the user that initiated the unsubscribe request.<DD><CODE>recipientJID</CODE> - the recipient user of the unsubscribe request.</DL>
</DD>
</DL>
<HR>

<A NAME="availableSession(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)"><!-- --></A><H3>
availableSession</H3>
<PRE>
public void <B>availableSession</B>(<A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A>&nbsp;session,
                             <A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#availableSession(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)">PresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a session that was not available is now
 available. A session becomes available when an available presence is received.
 Sessions that are available will have a route in the routing table thus becoming
 eligible for receiving messages (in particular messages sent to the user bare JID).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#availableSession(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)">availableSession</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html" title="interface in org.jivesoftware.openfire.user">PresenceEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the session that is now available.<DD><CODE>presence</CODE> - the received available presence.</DL>
</DD>
</DL>
<HR>

<A NAME="remoteUserAvailable(org.xmpp.packet.Presence)"><!-- --></A><H3>
remoteUserAvailable</H3>
<PRE>
public void <B>remoteUserAvailable</B>(<A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/RemotePresenceEventListener.html#remoteUserAvailable(org.xmpp.packet.Presence)">RemotePresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a remote user is now available or has changed
 his available presence. This event is triggered when an available presence is received
 by <tt>PresenceRouter</tt>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/RemotePresenceEventListener.html#remoteUserAvailable(org.xmpp.packet.Presence)">remoteUserAvailable</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/RemotePresenceEventListener.html" title="interface in org.jivesoftware.openfire.user">RemotePresenceEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>presence</CODE> - the received available presence.</DL>
</DD>
</DL>
<HR>

<A NAME="remoteUserUnavailable(org.xmpp.packet.Presence)"><!-- --></A><H3>
remoteUserUnavailable</H3>
<PRE>
public void <B>remoteUserUnavailable</B>(<A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>