clientsession.html

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

<A NAME="setActiveList(org.jivesoftware.openfire.privacy.PrivacyList)"><!-- --></A><H3>
setActiveList</H3>
<PRE>
void <B>setActiveList</B>(<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A>&nbsp;activeList)</PRE>
<DL>
<DD>Sets the Privacy list that overrides the default privacy list. This list affects
 only this session and only for the duration of the session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>activeList</CODE> - the Privacy list that overrides the default privacy list.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultList()"><!-- --></A><H3>
getDefaultList</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A> <B>getDefaultList</B>()</PRE>
<DL>
<DD>Returns the default Privacy list used for the session's user. This list is
 processed if there is no active list set for the session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the default Privacy list used for the session's user.</DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultList(org.jivesoftware.openfire.privacy.PrivacyList)"><!-- --></A><H3>
setDefaultList</H3>
<PRE>
void <B>setDefaultList</B>(<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A>&nbsp;defaultList)</PRE>
<DL>
<DD>Sets the default Privacy list used for the session's user. This list is
 processed if there is no active list set for the session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>defaultList</CODE> - the default Privacy list used for the session's user.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsername()"><!-- --></A><H3>
getUsername</H3>
<PRE>
<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>getUsername</B>()
                   throws <A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></PRE>
<DL>
<DD>Returns the username associated with this session. Use this information
 with the user manager to obtain the user based on username.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the username associated with this session
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></CODE> - if a user is not associated with a session
      (the session has not authenticated yet)</DL>
</DD>
</DL>
<HR>

<A NAME="isAnonymousUser()"><!-- --></A><H3>
isAnonymousUser</H3>
<PRE>
boolean <B>isAnonymousUser</B>()</PRE>
<DL>
<DD>Returns true if the authetnicated user is an anonymous user or if
 the use has not authenticated yet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the authetnicated user is an anonymous user or if
 the use has not authenticated yet.</DL>
</DD>
</DL>
<HR>

<A NAME="isInitialized()"><!-- --></A><H3>
isInitialized</H3>
<PRE>
boolean <B>isInitialized</B>()</PRE>
<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>
</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>
void <B>setInitialized</B>(boolean&nbsp;isInit)</PRE>
<DL>
<DD>Sets the initialization state of the session.
<P>
<DD><DL>
</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/ClientSession.html#isInitialized()"><CODE>isInitialized()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="canFloodOfflineMessages()"><!-- --></A><H3>
canFloodOfflineMessages</H3>
<PRE>
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>
</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>
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>
</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="getPresence()"><!-- --></A><H3>
getPresence</H3>
<PRE>
<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>
</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>
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>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>presence</CODE> - The presence for the session</DL>
</DD>
</DL>
<HR>

<A NAME="incrementConflictCount()"><!-- --></A><H3>
incrementConflictCount</H3>
<PRE>
int <B>incrementConflictCount</B>()</PRE>
<DL>
<DD>Increments the conflict by one and returns new number of conflicts detected on this session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the new number of conflicts detected on this session.</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="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/session/ClientSessionInfo.html" title="class in org.jivesoftware.openfire.session"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/session/ClientSession.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ClientSession.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>