connectionconfiguration.html

开源项目smack的API文件

<HR>

<A NAME="getSecurityMode()"><!-- --></A><H3>
getSecurityMode</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/smack/ConnectionConfiguration.SecurityMode.html" title="enum in org.jivesoftware.smack">ConnectionConfiguration.SecurityMode</A> <B>getSecurityMode</B>()</PRE>
<DL>
<DD>Returns the TLS security mode used when making the connection. By default,
 the mode is <A HREF="../../../org/jivesoftware/smack/ConnectionConfiguration.SecurityMode.html#enabled"><CODE>ConnectionConfiguration.SecurityMode.enabled</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the security mode.</DL>
</DD>
</DL>
<HR>

<A NAME="setSecurityMode(org.jivesoftware.smack.ConnectionConfiguration.SecurityMode)"><!-- --></A><H3>
setSecurityMode</H3>
<PRE>
public void <B>setSecurityMode</B>(<A HREF="../../../org/jivesoftware/smack/ConnectionConfiguration.SecurityMode.html" title="enum in org.jivesoftware.smack">ConnectionConfiguration.SecurityMode</A>&nbsp;securityMode)</PRE>
<DL>
<DD>Sets the TLS security mode used when making the connection. By default,
 the mode is <A HREF="../../../org/jivesoftware/smack/ConnectionConfiguration.SecurityMode.html#enabled"><CODE>ConnectionConfiguration.SecurityMode.enabled</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>securityMode</CODE> - the security mode.</DL>
</DD>
</DL>
<HR>

<A NAME="getTruststorePath()"><!-- --></A><H3>
getTruststorePath</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTruststorePath</B>()</PRE>
<DL>
<DD>Retuns the path to the trust store file. The trust store file contains the root
 certificates of several well known CAs. By default, will attempt to use the
 the file located in $JREHOME/lib/security/cacerts.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the path to the truststore file.</DL>
</DD>
</DL>
<HR>

<A NAME="setTruststorePath(java.lang.String)"><!-- --></A><H3>
setTruststorePath</H3>
<PRE>
public void <B>setTruststorePath</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;truststorePath)</PRE>
<DL>
<DD>Sets the path to the trust store file. The truststore file contains the root
 certificates of several well?known CAs. By default Smack is going to use
 the file located in $JREHOME/lib/security/cacerts.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>truststorePath</CODE> - the path to the truststore file.</DL>
</DD>
</DL>
<HR>

<A NAME="getTruststoreType()"><!-- --></A><H3>
getTruststoreType</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTruststoreType</B>()</PRE>
<DL>
<DD>Returns the trust store type, or <tt>null</tt> if it's not set.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the trust store type.</DL>
</DD>
</DL>
<HR>

<A NAME="setTruststoreType(java.lang.String)"><!-- --></A><H3>
setTruststoreType</H3>
<PRE>
public void <B>setTruststoreType</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;truststoreType)</PRE>
<DL>
<DD>Sets the trust store type.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>truststoreType</CODE> - the trust store type.</DL>
</DD>
</DL>
<HR>

<A NAME="getTruststorePassword()"><!-- --></A><H3>
getTruststorePassword</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTruststorePassword</B>()</PRE>
<DL>
<DD>Returns the password to use to access the trust store file. It is assumed that all
 certificates share the same password in the trust store.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the password to use to access the truststore file.</DL>
</DD>
</DL>
<HR>

<A NAME="setTruststorePassword(java.lang.String)"><!-- --></A><H3>
setTruststorePassword</H3>
<PRE>
public void <B>setTruststorePassword</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;truststorePassword)</PRE>
<DL>
<DD>Sets the password to use to access the trust store file. It is assumed that all
 certificates share the same password in the trust store.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>truststorePassword</CODE> - the password to use to access the truststore file.</DL>
</DD>
</DL>
<HR>

<A NAME="isVerifyChainEnabled()"><!-- --></A><H3>
isVerifyChainEnabled</H3>
<PRE>
public boolean <B>isVerifyChainEnabled</B>()</PRE>
<DL>
<DD>Returns true if the whole chain of certificates presented by the server are going to
 be checked. By default the certificate chain is not verified.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the whole chaing of certificates presented by the server are going to
         be checked.</DL>
</DD>
</DL>
<HR>

<A NAME="setVerifyChainEnabled(boolean)"><!-- --></A><H3>
setVerifyChainEnabled</H3>
<PRE>
public void <B>setVerifyChainEnabled</B>(boolean&nbsp;verifyChainEnabled)</PRE>
<DL>
<DD>Sets if the whole chain of certificates presented by the server are going to
 be checked. By default the certificate chain is not verified.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>verifyChainEnabled</CODE> - if the whole chaing of certificates presented by the server
        are going to be checked.</DL>
</DD>
</DL>
<HR>

<A NAME="isVerifyRootCAEnabled()"><!-- --></A><H3>
isVerifyRootCAEnabled</H3>
<PRE>
public boolean <B>isVerifyRootCAEnabled</B>()</PRE>
<DL>
<DD>Returns true if root CA checking is going to be done. By default checking is disabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if root CA checking is going to be done.</DL>
</DD>
</DL>
<HR>

<A NAME="setVerifyRootCAEnabled(boolean)"><!-- --></A><H3>
setVerifyRootCAEnabled</H3>
<PRE>
public void <B>setVerifyRootCAEnabled</B>(boolean&nbsp;verifyRootCAEnabled)</PRE>
<DL>
<DD>Sets if root CA checking is going to be done. By default checking is disabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>verifyRootCAEnabled</CODE> - if root CA checking is going to be done.</DL>
</DD>
</DL>
<HR>

<A NAME="isSelfSignedCertificateEnabled()"><!-- --></A><H3>
isSelfSignedCertificateEnabled</H3>
<PRE>
public boolean <B>isSelfSignedCertificateEnabled</B>()</PRE>
<DL>
<DD>Returns true if self-signed certificates are going to be accepted. By default
 this option is disabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if self-signed certificates are going to be accepted.</DL>
</DD>
</DL>
<HR>

<A NAME="setSelfSignedCertificateEnabled(boolean)"><!-- --></A><H3>
setSelfSignedCertificateEnabled</H3>
<PRE>
public void <B>setSelfSignedCertificateEnabled</B>(boolean&nbsp;selfSignedCertificateEnabled)</PRE>
<DL>
<DD>Sets if self-signed certificates are going to be accepted. By default
 this option is disabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>selfSignedCertificateEnabled</CODE> - if self-signed certificates are going to be accepted.</DL>
</DD>
</DL>
<HR>

<A NAME="isExpiredCertificatesCheckEnabled()"><!-- --></A><H3>
isExpiredCertificatesCheckEnabled</H3>
<PRE>
public boolean <B>isExpiredCertificatesCheckEnabled</B>()</PRE>
<DL>
<DD>Returns true if certificates presented by the server are going to be checked for their
 validity. By default certificates are not verified.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if certificates presented by the server are going to be checked for their
         validity.</DL>
</DD>
</DL>
<HR>

<A NAME="setExpiredCertificatesCheckEnabled(boolean)"><!-- --></A><H3>
setExpiredCertificatesCheckEnabled</H3>
<PRE>
public void <B>setExpiredCertificatesCheckEnabled</B>(boolean&nbsp;expiredCertificatesCheckEnabled)</PRE>
<DL>
<DD>Sets if certificates presented by the server are going to be checked for their
 validity. By default certificates are not verified.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expiredCertificatesCheckEnabled</CODE> - if certificates presented by the server are going
        to be checked for their validity.</DL>
</DD>
</DL>
<HR>