localclientsession.html

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

</DD>
</DL>
<HR>

<A NAME="getCompressionPolicy()"><!-- --></A><H3>
getCompressionPolicy</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/Connection.CompressionPolicy.html" title="enum in org.jivesoftware.openfire">Connection.CompressionPolicy</A> <B>getCompressionPolicy</B>()</PRE>
<DL>
<DD>Returns whether compression is optional or is disabled for clients.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>whether compression is optional or is disabled.</DL>
</DD>
</DL>
<HR>

<A NAME="setCompressionPolicy(org.jivesoftware.openfire.Connection.CompressionPolicy)"><!-- --></A><H3>
setCompressionPolicy</H3>
<PRE>
public static void <B>setCompressionPolicy</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.CompressionPolicy.html" title="enum in org.jivesoftware.openfire">Connection.CompressionPolicy</A>&nbsp;policy)</PRE>
<DL>
<DD>Sets whether compression is optional or is disabled for clients.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - whether compression is optional or is disabled.</DL>
</DD>
</DL>
<HR>

<A NAME="getActiveList()"><!-- --></A><H3>
getActiveList</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A> <B>getActiveList</B>()</PRE>
<DL>
<DD>Returns 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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#getActiveList()">getActiveList</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 Privacy list that overrides the default privacy list.</DL>
</DD>
</DL>
<HR>

<A NAME="setActiveList(org.jivesoftware.openfire.privacy.PrivacyList)"><!-- --></A><H3>
setActiveList</H3>
<PRE>
public 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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#setActiveList(org.jivesoftware.openfire.privacy.PrivacyList)">setActiveList</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>activeList</CODE> - the Privacy list that overrides the default privacy list.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultList()"><!-- --></A><H3>
getDefaultList</H3>
<PRE>
public <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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#getDefaultList()">getDefaultList</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 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>
public 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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#setDefaultList(org.jivesoftware.openfire.privacy.PrivacyList)">setDefaultList</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>defaultList</CODE> - the default Privacy list used for the session's user.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsername()"><!-- --></A><H3>
getUsername</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>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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#getUsername()">getUsername</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 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="setAuthToken(org.jivesoftware.openfire.auth.AuthToken)"><!-- --></A><H3>
setAuthToken</H3>
<PRE>
public void <B>setAuthToken</B>(<A HREF="../../../../org/jivesoftware/openfire/auth/AuthToken.html" title="class in org.jivesoftware.openfire.auth">AuthToken</A>&nbsp;auth)</PRE>
<DL>
<DD>Sets the new Authorization Token for this session. The session is not yet considered fully
 authenticated (i.e. active) since a resource has not been binded at this point. This
 message will be sent after SASL authentication was successful but yet resource binding
 is required.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>auth</CODE> - the authentication token obtained from SASL authentication.</DL>
</DD>
</DL>
<HR>

<A NAME="setAuthToken(org.jivesoftware.openfire.auth.AuthToken, java.lang.String)"><!-- --></A><H3>
setAuthToken</H3>
<PRE>
public void <B>setAuthToken</B>(<A HREF="../../../../org/jivesoftware/openfire/auth/AuthToken.html" title="class in org.jivesoftware.openfire.auth">AuthToken</A>&nbsp;auth,
                         <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;resource)</PRE>
<DL>
<DD>Initialize the session with a valid authentication token and
 resource name. This automatically upgrades the session's
 status to authenticated and enables many features that are not
 available until authenticated (obtaining managers for example).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>auth</CODE> - the authentication token obtained from the AuthFactory.<DD><CODE>resource</CODE> - the resource this session authenticated under.</DL>
</DD>
</DL>
<HR>

<A NAME="setAnonymousAuth()"><!-- --></A><H3>
setAnonymousAuth</H3>
<PRE>
public void <B>setAnonymousAuth</B>()</PRE>
<DL>
<DD>Initialize the session as an anonymous login. This automatically upgrades the session's
 status to authenticated and enables many features that are not available until
 authenticated (obtaining managers for example).<p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthToken()"><!-- --></A><H3>
getAuthToken</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/auth/AuthToken.html" title="class in org.jivesoftware.openfire.auth">AuthToken</A> <B>getAuthToken</B>()</PRE>
<DL>
<DD>Returns the authentication token associated with this session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the authentication token associated with this session (can be null).</DL>
</DD>
</DL>
<HR>

<A NAME="isAnonymousUser()"><!-- --></A><H3>
isAnonymousUser</H3>
<PRE>
public boolean <B>isAnonymousUser</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#isAnonymousUser()">ClientSession</A></CODE></B></DD>
<DD>Returns true if the authetnicated user is an anonymous user or if
 the use has not authenticated yet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/ClientSession.html#isAnonymousUser()">isAnonymousUser</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 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>
public boolean <B>isInitialized</B>()</PRE>