localclientsession.html

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

<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#close()">close</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#decodeVersion(java.lang.String)">decodeVersion</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getConnection()">getConnection</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getSessionData(java.lang.String)">getSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementClientPacketCount()">incrementClientPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementServerPacketCount()">incrementServerPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isClosed()">isClosed</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isSecure()">isSecure</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isUsingSelfSignedCertificate()">isUsingSelfSignedCertificate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#removeSessionData(java.lang.String)">removeSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setAddress(org.xmpp.packet.JID)">setAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setSessionData(java.lang.String, java.lang.Object)">setSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setStatus(int)">setStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<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></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.Session"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/Session.html" title="interface in org.jivesoftware.openfire.session">Session</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#close()">close</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isClosed()">isClosed</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isSecure()">isSecure</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="authToken"><!-- --></A><H3>
authToken</H3>
<PRE>
protected <A HREF="../../../../org/jivesoftware/openfire/auth/AuthToken.html" title="class in org.jivesoftware.openfire.auth">AuthToken</A> <B>authToken</B></PRE>
<DL>
<DD>The authentication token for this session.
<P>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="LocalClientSession(java.lang.String, org.jivesoftware.openfire.Connection, org.jivesoftware.openfire.StreamID)"><!-- --></A><H3>
LocalClientSession</H3>
<PRE>
public <B>LocalClientSession</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;serverName,
                          <A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection,
                          <A HREF="../../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;streamID)</PRE>
<DL>
<DD>Creates a session with an underlying connection and permission protection.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>serverName</CODE> - name of the server.<DD><CODE>connection</CODE> - The connection we are proxying.<DD><CODE>streamID</CODE> - unique identifier of this session.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getAllowedIPs()"><!-- --></A><H3>
getAllowedIPs</H3>
<PRE>
public static <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/String.html" title="class or interface in java.lang">String</A>&gt; <B>getAllowedIPs</B>()</PRE>
<DL>
<DD>Returns the list of IP address that are allowed to connect to the server. If the list is
 empty then anyone is allowed to connect to the server except for anonymous users that are
 subject to <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedAnonymIPs()"><CODE>getAllowedAnonymIPs()</CODE></A>. This list is used for both anonymous and
 non-anonymous users.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the list of IP address that are allowed to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getAllowedAnonymIPs()"><!-- --></A><H3>
getAllowedAnonymIPs</H3>
<PRE>
public static <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/String.html" title="class or interface in java.lang">String</A>&gt; <B>getAllowedAnonymIPs</B>()</PRE>
<DL>
<DD>Returns the list of IP address that are allowed to connect to the server for anonymous
 users. If the list is empty then anonymous will be only restricted by <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedIPs()"><CODE>getAllowedIPs()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the list of IP address that are allowed to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="createSession(java.lang.String, org.xmlpull.v1.XmlPullParser, org.jivesoftware.openfire.Connection)"><!-- --></A><H3>
createSession</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A> <B>createSession</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;serverName,
                                               org.xmlpull.v1.XmlPullParser&nbsp;xpp,
                                               <A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection)
                                        throws org.xmlpull.v1.XmlPullParserException</PRE>
<DL>
<DD>Returns a newly created session between the server and a client. The session will
 be created and returned only if correct name/prefix (i.e. 'stream' or 'flash')
 and namespace were provided by the client.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serverName</CODE> - the name of the server where the session is connecting to.<DD><CODE>xpp</CODE> - the parser that is reading the provided XML through the connection.<DD><CODE>connection</CODE> - the connection with the client.
<DT><B>Returns:</B><DD>a newly created session between the server and a client.
<DT><B>Throws:</B>
<DD><CODE>org.xmlpull.v1.XmlPullParserException</CODE> - if an error occurs while parsing incoming data.</DL>
</DD>
</DL>
<HR>

<A NAME="isAllowed(org.jivesoftware.openfire.Connection)"><!-- --></A><H3>
isAllowed</H3>
<PRE>
public static boolean <B>isAllowed</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setAllowedIPs(java.util.Map)"><!-- --></A><H3>
setAllowedIPs</H3>
<PRE>
public static void <B>setAllowedIPs</B>(<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/String.html" title="class or interface in java.lang">String</A>&gt;&nbsp;allowed)</PRE>
<DL>
<DD>Sets the list of IP address that are allowed to connect to the server. If the list is
 empty then anyone is allowed to connect to the server except for anonymous users that are
 subject to <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedAnonymIPs()"><CODE>getAllowedAnonymIPs()</CODE></A>. This list is used for both anonymous and
 non-anonymous users.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowed</CODE> - the list of IP address that are allowed to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="setAllowedAnonymIPs(java.util.Map)"><!-- --></A><H3>
setAllowedAnonymIPs</H3>
<PRE>
public static void <B>setAllowedAnonymIPs</B>(<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/String.html" title="class or interface in java.lang">String</A>&gt;&nbsp;allowed)</PRE>
<DL>
<DD>Sets the list of IP address that are allowed to connect to the server for anonymous
 users. If the list is empty then anonymous will be only restricted by <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html#getAllowedIPs()"><CODE>getAllowedIPs()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowed</CODE> - the list of IP address that are allowed to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getTLSPolicy()"><!-- --></A><H3>
getTLSPolicy</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/Connection.TLSPolicy.html" title="enum in org.jivesoftware.openfire">Connection.TLSPolicy</A> <B>getTLSPolicy</B>()</PRE>
<DL>
<DD>Returns whether TLS is mandatory, optional or is disabled for clients. When TLS is
 mandatory clients are required to secure their connections or otherwise their connections
 will be closed. On the other hand, when TLS is disabled clients are not allowed to secure
 their connections using TLS. Their connections will be closed if they try to secure the
 connection. in this last case.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

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

<A NAME="setTLSPolicy(org.jivesoftware.openfire.Connection.TLSPolicy)"><!-- --></A><H3>
setTLSPolicy</H3>
<PRE>
public static void <B>setTLSPolicy</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.TLSPolicy.html" title="enum in org.jivesoftware.openfire">Connection.TLSPolicy</A>&nbsp;policy)</PRE>
<DL>
<DD>Sets whether TLS is mandatory, optional or is disabled for clients. When TLS is
 mandatory clients are required to secure their connections or otherwise their connections
 will be closed. On the other hand, when TLS is disabled clients are not allowed to secure
 their connections using TLS. Their connections will be closed if they try to secure the
 connection. in this last case.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - whether TLS is mandatory, optional or is disabled.</DL>