socketconnection.html

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

<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 void <B>setTlsPolicy</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.TLSPolicy.html" title="enum in org.jivesoftware.openfire">Connection.TLSPolicy</A>&nbsp;tlsPolicy)</PRE>
<DL>
<DD>Sets whether TLS is mandatory, optional or is disabled. 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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setTlsPolicy(org.jivesoftware.openfire.Connection.TLSPolicy)">setTlsPolicy</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>tlsPolicy</CODE> - whether TLS is mandatory, optional or is disabled.</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>Sets whether compression is enabled or is disabled.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setCompressionPolicy(org.jivesoftware.openfire.Connection.CompressionPolicy)">setCompressionPolicy</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>compressionPolicy</CODE> - whether Compression is enabled or is disabled.</DL>
</DD>
</DL>
<HR>

<A NAME="getIdleTimeout()"><!-- --></A><H3>
getIdleTimeout</H3>
<PRE>
public long <B>getIdleTimeout</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setIdleTimeout(long)"><!-- --></A><H3>
setIdleTimeout</H3>
<PRE>
public void <B>setIdleTimeout</B>(long&nbsp;timeout)</PRE>
<DL>
<DD>Sets the number of milliseconds a connection has to be idle to be closed. Sending
 stanzas to the client is not considered as activity. We are only considering the
 connection active when the client sends some data or hearbeats (i.e. whitespaces)
 to the server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the number of milliseconds a connection has to be idle to be closed.</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>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>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="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>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="getLocalCertificates()"><!-- --></A><H3>
getLocalCertificates</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/security/cert/Certificate.html" title="class or interface in java.security.cert">Certificate</A>[] <B>getLocalCertificates</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getLocalCertificates()">Connection</A></CODE></B></DD>
<DD>Returns the local underlying <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/javax/security/cert/X509Certificate.html" title="class or interface in javax.security.cert"><CODE>X509Certificate</CODE></A> for the connection.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getLocalCertif