virtualconnection.html

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

<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="session"><!-- --></A><H3>
session</H3>
<PRE>
protected <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A> <B>session</B></PRE>
<DL>
<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="VirtualConnection()"><!-- --></A><H3>
VirtualConnection</H3>
<PRE>
public <B>VirtualConnection</B>()</PRE>
<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="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="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="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#getLocalCertificates()">getLocalCertificates</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><tt>null</tt> if no <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> is present for the connection.</DL>
</DD>
</DL>
<HR>

<A NAME="getPeerCertificates()"><!-- --></A><H3>
getPeerCertificates</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>getPeerCertificates</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getPeerCertificates()">Connection</A></CODE></B></DD>
<DD>Returns the 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 of the peer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#getPeerCertificates()">getPeerCertificates</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><tt>null</tt> if no <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> is present for the connection.</DL>
</DD>
</DL>
<HR>

<A NAME="setUsingSelfSignedCertificate(boolean)"><!-- --></A><H3>
setUsingSelfSignedCertificate</H3>
<PRE>
public void <B>setUsingSelfSignedCertificate</B>(boolean&nbsp;isSelfSigned)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setUsingSelfSignedCertificate(boolean)">Connection</A></CODE></B></DD>
<DD>Keeps track if the other peer of this session presented a self-signed certificate. When
 using self-signed certificate for server-2-server sessions then SASL EXTERNAL will not be
 used and instead server-dialback will be preferred for vcerifying the identify of the remote
 server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#setUsingSelfSignedCertificate(boolean)">setUsingSelfSignedCertificate</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>isSelfSigned</CODE> - true if the other peer presented a self-signed certificate.</DL>
</DD>
</DL>
<HR>

<A NAME="isUsingSelfSignedCertificate()"><!-- --></A><H3>
isUsingSelfSignedCertificate</H3>
<PRE>
public boolean <B>isUsingSelfSignedCertificate</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isUsingSelfSignedCertificate()">Connection</A></CODE></B></DD>
<DD>Returns true if the other peer of this session presented a self-signed certificate. When
 using self-signed certificate for server-2-server sessions then SASL EXTERNAL will not be
 used and instead server-dialback will be preferred for vcerifying the identify of the remote
 server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isUsingSelfSignedCertificate()">isUsingSelfSignedCertificate</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 other peer of this session presented a self-signed certificate.</DL>
</DD>
</DL>
<HR>

<A NAME="isClosed()"><!-- --></A><H3>
isClosed</H3>
<PRE>
public boolean <B>isClosed</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isClosed()">Connection</A></CODE></B></DD>
<DD>Returns true if the connection/session is closed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/Connection.html#isClosed()">isClosed</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 closed.</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="getTlsPolicy()"><!-- --></A><H3>
getTlsPolicy</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/Connection.TLSPolicy.html" title="enum in org.jivesoftware.openfire">Connection.TLSPolicy</A> <B>getTlsPolicy</B>()</PRE>