nioconnection.html

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

<DT><B>Parameters:</B><DD><CODE>clientMode</CODE> - boolean indicating if this entity is a client or a server in the TLS negotiation.<DD><CODE>remoteServer</CODE> - xmpp domain of the remote server or <tt>null</tt>. When null a
       <A HREF="../../../../org/jivesoftware/openfire/net/ClientTrustManager.html" title="class in org.jivesoftware.openfire.net"><CODE>ClientTrustManager</CODE></A> will be used for verifying certificates
       otherwise a <A HREF="../../../../org/jivesoftware/openfire/net/ServerTrustManager.html" title="class in org.jivesoftware.openfire.net"><CODE>ServerTrustManager</CODE></A> will be used.<DD><CODE>authentication</CODE> - policy to use for authenticating the remote peer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE> - if an error occured while securing the connection.</DL>
</DD>
</DL>
<HR>

<A NAME="addCompression()"><!-- --></A><H3>
addCompression</H3>
<PRE>
public void <B>addCompression</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#addCompression()">Connection</A></CODE></B></DD>
<DD>Adds the compression filter to the connection but only filter incoming traffic. Do not filter
 outgoing traffic since we still need to send an uncompressed stanza to the client indicating
 that he can start compressing the traffic. After we sent the uncompresses stanza we can
 start compression outgoing traffic as well.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#addCompression()">addCompression</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="startCompression()"><!-- --></A><H3>
startCompression</H3>
<PRE>
public void <B>startCompression</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#startCompression()">Connection</A></CODE></B></DD>
<DD>Start compressing outgoing traffic for this connection. Compression will only be available after
 TLS has been negotiated. This means that a connection can never be using compression before
 TLS. However, it is possible to use compression without TLS.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#startCompression()">startCompression</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isFlashClient()"><!-- --></A><H3>
isFlashClient</H3>
<PRE>
public boolean <B>isFlashClient</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isFlashClient()">Connection</A></CODE></B></DD>
<DD>Returns true if the connected client is a flash client. Flash clients need
 to receive a special character (i.e. \0) at the end of each xml packet. Flash
 clients may send the character \0 in incoming packets and may start a connection
 using another openning tag such as: "flash:client".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isFlashClient()">isFlashClient</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the connected client is a flash client.</DL>
</DD>
</DL>
<HR>

<A NAME="setFlashClient(boolean)"><!-- --></A><H3>
setFlashClient</H3>
<PRE>
public void <B>setFlashClient</B>(boolean&nbsp;flashClient)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setFlashClient(boolean)">Connection</A></CODE></B></DD>
<DD>Sets whether the connected client is a flash client. Flash clients need to
 receive a special character (i.e. \0) at the end of each xml packet. Flash
 clients may send the character \0 in incoming packets and may start a
 connection using another openning tag such as: "flash:client".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setFlashClient(boolean)">setFlashClient</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flashClient</CODE> - true if the if the connection is a flash client.</DL>
</DD>
</DL>
<HR>

<A NAME="getMajorXMPPVersion()"><!-- --></A><H3>
getMajorXMPPVersion</H3>
<PRE>
public int <B>getMajorXMPPVersion</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getMajorXMPPVersion()">Connection</A></CODE></B></DD>
<DD>Returns the major version of XMPP being used by this connection
 (major_version.minor_version. In most cases, the version should be
 "1.0". However, older clients using the "Jabber" protocol do not set a
 version. In that case, the version is "0.0".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getMajorXMPPVersion()">getMajorXMPPVersion</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the major XMPP version being used by this connection.</DL>
</DD>
</DL>
<HR>

<A NAME="getMinorXMPPVersion()"><!-- --></A><H3>
getMinorXMPPVersion</H3>
<PRE>
public int <B>getMinorXMPPVersion</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getMinorXMPPVersion()">Connection</A></CODE></B></DD>
<DD>Returns the minor version of XMPP being used by this connection
 (major_version.minor_version. In most cases, the version should be
 "1.0". However, older clients using the "Jabber" protocol do not set a
 version. In that case, the version is "0.0".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getMinorXMPPVersion()">getMinorXMPPVersion</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the minor XMPP version being used by this connection.</DL>
</DD>
</DL>
<HR>

<A NAME="setXMPPVersion(int, int)"><!-- --></A><H3>
setXMPPVersion</H3>
<PRE>
public void <B>setXMPPVersion</B>(int&nbsp;majorVersion,
                           int&nbsp;minorVersion)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setXMPPVersion(int, int)">Connection</A></CODE></B></DD>
<DD>Sets the XMPP version information. In most cases, the version should be "1.0".
 However, older clients using the "Jabber" protocol do not set a version. In that
 case, the version is "0.0".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setXMPPVersion(int, int)">setXMPPVersion</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>majorVersion</CODE> - the major version.<DD><CODE>minorVersion</CODE> - the minor version.</DL>
</DD>
</DL>
<HR>

<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</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>getLanguage</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getLanguage()">Connection</A></CODE></B></DD>
<DD>Returns the language code that should be used for this connection
 (e.g. "en").
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getLanguage()">getLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the language code for the connection.</DL>
</DD>
</DL>
<HR>

<A NAME="setLanaguage(java.lang.String)"><!-- --></A><H3>
setLanaguage</H3>
<PRE>
public void <B>setLanaguage</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;language)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setLanaguage(java.lang.String)">Connection</A></CODE></B></DD>
<DD>Sets the language code that should be used for this connection (e.g. "en").
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setLanaguage(java.lang.String)">setLanaguage</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>language</CODE> - the language code.</DL>
</DD>
</DL>
<HR>

<A NAME="isCompressed()"><!-- --></A><H3>
isCompressed</H3>
<PRE>
public boolean <B>isCompressed</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isCompressed()">Connection</A></CODE></B></DD>
<DD>Returns true if the connection is using compression.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isCompressed()">isCompressed</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the connection is using compression.</DL>
</DD>
</DL>
<HR>

<A NAME="getCompressionPolicy()"><!-- --></A><H3>
getCompressionPolicy</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/Connection.CompressionPolicy.html" title="enum in org.jivesoftware.openfire">Connection.CompressionPolicy</A> <B>getCompressionPolicy</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getCompressionPolicy()">Connection</A></CODE></B></DD>
<DD>Returns whether compression is optional or is disabled.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getCompressionPolicy()">getCompressionPolicy</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A></CODE></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 void <B>setCompressionPolicy</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.CompressionPolicy.html" title="enum in org.jivesoftware.openfire">Connection.CompressionPolicy</A>&nbsp;compressionPolicy)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setCompressionPolicy(org.jivesoftware.openfire.Connecti