iqpephandler.html

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

<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/RemotePresenceEventListener.html#remoteUserUnavailable(org.xmpp.packet.Presence)">RemotePresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a remote user is no longer available.
 A remote user becomes unavailable when an unavailable 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#remoteUserUnavailable(org.xmpp.packet.Presence)">remoteUserUnavailable</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 unavailable presence.</DL>
</DD>
</DL>
<HR>

<A NAME="contactDeleted(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)"><!-- --></A><H3>
contactDeleted</H3>
<PRE>
public void <B>contactDeleted</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/Roster.html" title="class in org.jivesoftware.openfire.roster">Roster</A>&nbsp;roster,
                           <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactDeleted(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">RosterEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a contact has been deleted from a roster.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactDeleted(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">contactDeleted</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html" title="interface in org.jivesoftware.openfire.roster">RosterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roster</CODE> - the roster that was updated.<DD><CODE>item</CODE> - the roster item that was deleted.</DL>
</DD>
</DL>
<HR>

<A NAME="userDeleting(org.jivesoftware.openfire.user.User, java.util.Map)"><!-- --></A><H3>
userDeleting</H3>
<PRE>
public void <B>userDeleting</B>(<A HREF="../../../../org/jivesoftware/openfire/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&nbsp;user,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</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>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&gt;&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html#userDeleting(org.jivesoftware.openfire.user.User, java.util.Map)">UserEventListener</A></CODE></B></DD>
<DD>A user is being deleted.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html#userDeleting(org.jivesoftware.openfire.user.User, java.util.Map)">userDeleting</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html" title="interface in org.jivesoftware.openfire.event">UserEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="unavailableSession(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)"><!-- --></A><H3>
unavailableSession</H3>
<PRE>
public void <B>unavailableSession</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>The following functions are unimplemented required interface methods.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#unavailableSession(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)">unavailableSession</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 no longer available.<DD><CODE>presence</CODE> - the received unavailable presence.</DL>
</DD>
</DL>
<HR>

<A NAME="presenceChanged(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)"><!-- --></A><H3>
presenceChanged</H3>
<PRE>
public void <B>presenceChanged</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#presenceChanged(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)">PresenceEventListener</A></CODE></B></DD>
<DD>Notification message indicating that an available session has changed its
 presence. This is the case when the user presence changed the show value
 (e.g. away, dnd, etc.) or the presence status message.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/PresenceEventListener.html#presenceChanged(org.jivesoftware.openfire.session.ClientSession, org.xmpp.packet.Presence)">presenceChanged</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 affected session.<DD><CODE>presence</CODE> - the received available presence with the new information.</DL>
</DD>
</DL>
<HR>

<A NAME="addingContact(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem, boolean)"><!-- --></A><H3>
addingContact</H3>
<PRE>
public boolean <B>addingContact</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/Roster.html" title="class in org.jivesoftware.openfire.roster">Roster</A>&nbsp;roster,
                             <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item,
                             boolean&nbsp;persistent)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#addingContact(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem, boolean)">RosterEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a contact is about to be added to a roster. New
 contacts may be persisted to the database or not. Listeners may indicate that contact
 about to be persisted should not be persisted. Only one listener is needed to return
 <tt>false</tt> so that the contact is not persisted.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#addingContact(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem, boolean)">addingContact</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html" title="interface in org.jivesoftware.openfire.roster">RosterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roster</CODE> - the roster that was updated.<DD><CODE>item</CODE> - the new roster item.<DD><CODE>persistent</CODE> - true if the new contact is going to be saved to the database.
<DT><B>Returns:</B><DD>false if the contact should not be persisted to the database.</DL>
</DD>
</DL>
<HR>

<A NAME="contactAdded(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)"><!-- --></A><H3>
contactAdded</H3>
<PRE>
public void <B>contactAdded</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/Roster.html" title="class in org.jivesoftware.openfire.roster">Roster</A>&nbsp;roster,
                         <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactAdded(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">RosterEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a contact has been added to a roster.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactAdded(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">contactAdded</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html" title="interface in org.jivesoftware.openfire.roster">RosterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roster</CODE> - the roster that was updated.<DD><CODE>item</CODE> - the new roster item.</DL>
</DD>
</DL>
<HR>

<A NAME="contactUpdated(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)"><!-- --></A><H3>
contactUpdated</H3>
<PRE>
public void <B>contactUpdated</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/Roster.html" title="class in org.jivesoftware.openfire.roster">Roster</A>&nbsp;roster,
                           <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactUpdated(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">RosterEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a contact has been updated.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#contactUpdated(org.jivesoftware.openfire.roster.Roster, org.jivesoftware.openfire.roster.RosterItem)">contactUpdated</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html" title="interface in org.jivesoftware.openfire.roster">RosterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roster</CODE> - the roster that was updated.<DD><CODE>item</CODE> - the updated roster item.</DL>
</DD>
</DL>
<HR>

<A NAME="rosterLoaded(org.jivesoftware.openfire.roster.Roster)"><!-- --></A><H3>
rosterLoaded</H3>
<PRE>
public void <B>rosterLoaded</B>(<A HREF="../../../../org/jivesoftware/openfire/roster/Roster.html" title="class in org.jivesoftware.openfire.roster">Roster</A>&nbsp;roster)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#rosterLoaded(org.jivesoftware.openfire.roster.Roster)">RosterEventListener</A></CODE></B></DD>
<DD>Notification message indicating that a roster has just been loaded.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html#rosterLoaded(org.jivesoftware.openfire.roster.Roster)">rosterLoaded</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/roster/RosterEventListener.html" title="interface in org.jivesoftware.openfire.roster">RosterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roster</CODE> - the loaded roster.</DL>
</DD>
</DL>
<HR>

<A NAME="userCreated(org.jivesoftware.openfire.user.User, java.util.Map)"><!-- --></A><H3>
userCreated</H3>
<PRE>
public void <B>userCreated</B>(<A HREF="../../../../org/jivesoftware/openfire/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&nbsp;user,
                        <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</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>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&gt;&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html#userCreated(org.jivesoftware.openfire.user.User, java.util.Map)">UserEventListener</A></CODE></B></DD>
<DD>A user was created.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html#userCreated(org.jivesoftware.openfire.user.User, java.util.Map)">userCreated</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/UserEventListener.html" title="interface in org.jivesoftware.openfire.event">UserEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="userModified(org.jivesoftware.openfire.user.User, java.util.Map)"><!-- --></A><H3>
userModified</H3>
<PRE>
public void <B>userModified</B>(<A HREF="../../../../org/jivesoftware/openfire/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&nbsp;user,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</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>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="c