localclientsession.html

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

<DL>
<DD>Flag indicating if this session has been initialized once coming
 online. Session initialization occurs after the session receives
 the first "available" presence update from the client. Initialization
 actions include pushing offline messages, presence subscription requests,
 and presence statuses to the client. Initialization occurs only once
 following the first available presence transition.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#isInitialized()">isInitialized</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>True if the session has already been initializsed</DL>
</DD>
</DL>
<HR>

<A NAME="setInitialized(boolean)"><!-- --></A><H3>
setInitialized</H3>
<PRE>
public void <B>setInitialized</B>(boolean&nbsp;isInit)</PRE>
<DL>
<DD>Sets the initialization state of the session.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#setInitialized(boolean)">setInitialized</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isInit</CODE> - True if the session has been initialized<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#isInitialized()"><CODE>isInitialized()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="wasAvailable()"><!-- --></A><H3>
wasAvailable</H3>
<PRE>
public boolean <B>wasAvailable</B>()</PRE>
<DL>
<DD>Returns true if the session was available ever.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the session was available ever.</DL>
</DD>
</DL>
<HR>

<A NAME="canFloodOfflineMessages()"><!-- --></A><H3>
canFloodOfflineMessages</H3>
<PRE>
public boolean <B>canFloodOfflineMessages</B>()</PRE>
<DL>
<DD>Returns true if the offline messages of the user should be sent to the user when
 the user becomes online. If the user sent a disco request with node
 "http://jabber.org/protocol/offline" before the available presence then do not
 flood the user with the offline messages. If the user is connected from many resources
 then if one of the sessions stopped the flooding then no session should flood the user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#canFloodOfflineMessages()">canFloodOfflineMessages</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the offline messages of the user should be sent to the user when the user
         becomes online.</DL>
</DD>
</DL>
<HR>

<A NAME="isOfflineFloodStopped()"><!-- --></A><H3>
isOfflineFloodStopped</H3>
<PRE>
public boolean <B>isOfflineFloodStopped</B>()</PRE>
<DL>
<DD>Returns true if the user requested to not receive offline messages when sending
 an available presence. The user may send a disco request with node
 "http://jabber.org/protocol/offline" so that no offline messages are sent to the
 user when he becomes online. If the user is connected from many resources then
 if one of the sessions stopped the flooding then no session should flood the user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#isOfflineFloodStopped()">isOfflineFloodStopped</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the user requested to not receive offline messages when sending
         an available presence.</DL>
</DD>
</DL>
<HR>

<A NAME="setOfflineFloodStopped(boolean)"><!-- --></A><H3>
setOfflineFloodStopped</H3>
<PRE>
public void <B>setOfflineFloodStopped</B>(boolean&nbsp;offlineFloodStopped)</PRE>
<DL>
<DD>Sets if the user requested to not receive offline messages when sending
 an available presence. The user may send a disco request with node
 "http://jabber.org/protocol/offline" so that no offline messages are sent to the
 user when he becomes online. If the user is connected from many resources then
 if one of the sessions stopped the flooding then no session should flood the user.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>offlineFloodStopped</CODE> - if the user requested to not receive offline messages when
        sending an available presence.</DL>
</DD>
</DL>
<HR>

<A NAME="getPresence()"><!-- --></A><H3>
getPresence</H3>
<PRE>
public <A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A> <B>getPresence</B>()</PRE>
<DL>
<DD>Obtain the presence of this session.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#getPresence()">getPresence</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The presence of this session or null if not authenticated</DL>
</DD>
</DL>
<HR>

<A NAME="setPresence(org.xmpp.packet.Presence)"><!-- --></A><H3>
setPresence</H3>
<PRE>
public void <B>setPresence</B>(<A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>
<DL>
<DD>Set the presence of this session
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#setPresence(org.xmpp.packet.Presence)">setPresence</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>presence</CODE> - The presence for the session</DL>
</DD>
</DL>
<HR>

<A NAME="getAvailableStreamFeatures()"><!-- --></A><H3>
getAvailableStreamFeatures</H3>
<PRE>
public <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> <B>getAvailableStreamFeatures</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAvailableStreamFeatures()">LocalSession</A></CODE></B></DD>
<DD>Returns a text with the available stream features. Each subclass may return different
 values depending whether the session has been authenticated or not.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAvailableStreamFeatures()">getAvailableStreamFeatures</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a text with the available stream features or <tt>null</tt> to add nothing.</DL>
</DD>
</DL>
<HR>

<A NAME="incrementConflictCount()"><!-- --></A><H3>
incrementConflictCount</H3>
<PRE>
public int <B>incrementConflictCount</B>()</PRE>
<DL>
<DD>Increments the conflict by one.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#incrementConflictCount()">incrementConflictCount</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html" title="interface in org.jivesoftware.openfire.session">ClientSession</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the new number of conflicts detected on this session.</DL>
</DD>
</DL>
<HR>

<A NAME="canProcess(org.xmpp.packet.Packet)"><!-- --></A><H3>
canProcess</H3>
<PRE>
public boolean <B>canProcess</B>(<A HREF="../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet)</PRE>
<DL>
<DD>Returns true if the specified packet must not be blocked based on the active or default
 privacy list rules. The active list will be tried first. If none was found then the
 default list is going to be used. If no default list was defined for this user then
 allow the packet to flow.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - the packet to analyze if it must be blocked.
<DT><B>Returns:</B><DD>true if the specified packet must be blocked.</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <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> <B>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING