Modified: websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/IMAPSClient.html ============================================================================== --- websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/IMAPSClient.html (original) +++ websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/IMAPSClient.html Sun Oct 18 14:48:36 2020 @@ -45,355 +45,364 @@ <a class="jxr_linenumber" name="L37" href="#L37">37</a> <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * The IMAPSClient class provides SSL/TLS connection encryption to IMAPClient.</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Copied from FTPSClient.java and modified to suit IMAP.</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * If implicit mode is selected (NOT the default), SSL/TLS negotiation starts right</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * after the connection has been established. In explicit mode (the default), SSL/TLS</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * negotiation starts when the user calls execTLS() and the server accepts the command.</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Implicit usage:</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * IMAPSClient c = new IMAPSClient(true);</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * c.connect("127.0.0.1", 993);</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Explicit usage:</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * IMAPSClient c = new IMAPSClient();</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * c.connect("127.0.0.1", 143);</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * if (c.execTLS()) { /rest of the commands here/ }</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Warning: the hostname is not verified against the certificate by default, use</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * {@link #setHostnameVerifier(HostnameVerifier)} or {@link #setEndpointCheckingEnabled(boolean)}</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * (on Java 1.7+) to enable verification.</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a> <strong class="jxr_keyword">extends</strong> <a name="IMAPClient" href="../../../../../org/apache/commons/net/imap/IMAPClient.html#IMAPClient">IMAPClient</a> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> { -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/** The default IMAP over SSL port. */</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_IMAPS_PORT = 993; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/** Default secure socket protocol name. */</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PROTOCOL = <span class="jxr_string">"TLS"</span>; -<a class="jxr_linenumber" name="L63" href="#L63">63</a> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/** The security mode. True - Implicit Mode / False - Explicit Mode. */</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isImplicit; -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/** The secure socket protocol to be used, like SSL/TLS. */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String protocol; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/** The context object. */</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> SSLContext context = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/** The cipher suites. SSLSockets have a default set of these anyway,</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> so no initialization required. */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> String[] suites = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/** The protocol versions. */</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> String[] protocols = <em class="jxr_comment">//null;</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">null</strong>;<em class="jxr_comment">//{"SSLv2", "SSLv3", "TLSv1", "TLSv1.1", "SSLv2Hello"};</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/** The IMAPS {@link TrustManager} implementation, default null. */</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> TrustManager trustManager = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L79" href="#L79">79</a> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/** The {@link KeyManager}, default null. */</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> KeyManager keyManager = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L82" href="#L82">82</a> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/** The {@link HostnameVerifier} to use post-TLS, default null (i.e. no verification). */</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> HostnameVerifier hostnameVerifier = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Copied from</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://commons.apache.org/proper/commons-net/apidocs/index.html?org/apache/commons/net/ftp/FTPSClient.html" target="alexandria_uri">http://commons.apache.org/proper/commons-net/apidocs/index.html?org/apache/commons/net/ftp/FTPSClient.html</a>"></em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * FTPSClient</a> and modified to suit IMAP.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * If implicit mode is selected (NOT the default), SSL/TLS negotiation starts right</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * after the connection has been established. In explicit mode (the default), SSL/TLS</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * negotiation starts when the user calls execTLS() and the server accepts the command.</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@code</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * //Implicit usage:</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * IMAPSClient c = new IMAPSClient(true);</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * c.connect("127.0.0.1", 993);</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * //Explicit usage:</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * IMAPSClient c = new IMAPSClient();</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * c.connect("127.0.0.1", 143);</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * if (c.execTLS()) { /rest of the commands here/ }</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * }</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * <b>Warning</b>: the hostname is not verified against the certificate by default, use</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * {@link #setHostnameVerifier(HostnameVerifier)} or {@link #setEndpointCheckingEnabled(boolean)}</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * (on Java 1.7+) to enable verification.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a> <strong class="jxr_keyword">extends</strong> <a name="IMAPClient" href="../../../../../org/apache/commons/net/imap/IMAPClient.html#IMAPClient">IMAPClient</a> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> { +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/** The default IMAP over SSL port. */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_IMAPS_PORT = 993; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/** Default secure socket protocol name. */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PROTOCOL = <span class="jxr_string">"TLS"</span>; +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/** The security mode. True - Implicit Mode / False - Explicit Mode. */</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isImplicit; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/** The secure socket protocol to be used, like SSL/TLS. */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String protocol; +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/** The context object. */</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> SSLContext context = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/** The cipher suites. SSLSockets have a default set of these anyway,</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> so no initialization required. */</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> String[] suites = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/** The protocol versions. */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> String[] protocols = <em class="jxr_comment">//null;</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">null</strong>;<em class="jxr_comment">//{"SSLv2", "SSLv3", "TLSv1", "TLSv1.1", "SSLv2Hello"};</em> <a class="jxr_linenumber" name="L85" href="#L85">85</a> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/** Use Java 1.7+ HTTPS Endpoint Identification Algorithim. */</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> tlsEndpointChecking; +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/** The IMAPS {@link TrustManager} implementation, default null. */</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> TrustManager trustManager = <strong class="jxr_keyword">null</strong>; <a class="jxr_linenumber" name="L88" href="#L88">88</a> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Sets security mode to explicit (isImplicit = false).</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>() -<a class="jxr_linenumber" name="L94" href="#L94">94</a> { -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, false); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> } +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/** The {@link KeyManager}, default null. */</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> KeyManager keyManager = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/** The {@link HostnameVerifier} to use post-TLS, default null (i.e. no verification). */</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> HostnameVerifier hostnameVerifier = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/** Use Java 1.7+ HTTPS Endpoint Identification Algorithim. */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> tlsEndpointChecking; <a class="jxr_linenumber" name="L97" href="#L97">97</a> <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param implicit The security mode (Implicit/Explicit).</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * Sets security mode to explicit (isImplicit = false).</em> <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit) +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>() <a class="jxr_linenumber" name="L103" href="#L103">103</a> { -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, implicit); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, false); <a class="jxr_linenumber" name="L105" href="#L105">105</a> } <a class="jxr_linenumber" name="L106" href="#L106">106</a> <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param proto the protocol.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param implicit The security mode (Implicit/Explicit).</em> <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto) +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit) <a class="jxr_linenumber" name="L112" href="#L112">112</a> { -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">this</strong>(proto, false); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, implicit); <a class="jxr_linenumber" name="L114" href="#L114">114</a> } <a class="jxr_linenumber" name="L115" href="#L115">115</a> <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @param proto the protocol.</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit) -<a class="jxr_linenumber" name="L122" href="#L122">122</a> { -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>(proto, implicit, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L124" href="#L124">124</a> } -<a class="jxr_linenumber" name="L125" href="#L125">125</a> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param proto the protocol.</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @param ctx the SSL context</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit, <strong class="jxr_keyword">final</strong> SSLContext ctx) -<a class="jxr_linenumber" name="L133" href="#L133">133</a> { -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">super</strong>(); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> setDefaultPort(DEFAULT_IMAPS_PORT); -<a class="jxr_linenumber" name="L136" href="#L136">136</a> protocol = proto; -<a class="jxr_linenumber" name="L137" href="#L137">137</a> isImplicit = implicit; -<a class="jxr_linenumber" name="L138" href="#L138">138</a> context = ctx; -<a class="jxr_linenumber" name="L139" href="#L139">139</a> } -<a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @param ctx A pre-configured SSL Context.</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit, <strong class="jxr_keyword">final</strong> SSLContext ctx) -<a class="jxr_linenumber" name="L147" href="#L147">147</a> { -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, implicit, ctx); -<a class="jxr_linenumber" name="L149" href="#L149">149</a> } -<a class="jxr_linenumber" name="L150" href="#L150">150</a> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @param context A pre-configured SSL Context.</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto) +<a class="jxr_linenumber" name="L121" href="#L121">121</a> { +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">this</strong>(proto, false); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param proto the protocol.</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit) +<a class="jxr_linenumber" name="L131" href="#L131">131</a> { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">this</strong>(proto, implicit, <strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param proto the protocol.</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param ctx the SSL context</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> String proto, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit, <strong class="jxr_keyword">final</strong> SSLContext ctx) +<a class="jxr_linenumber" name="L142" href="#L142">142</a> { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">super</strong>(); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> setDefaultPort(DEFAULT_IMAPS_PORT); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> protocol = proto; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> isImplicit = implicit; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> context = ctx; +<a class="jxr_linenumber" name="L148" href="#L148">148</a> } +<a class="jxr_linenumber" name="L149" href="#L149">149</a> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @param implicit The security mode(Implicit/Explicit).</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @param ctx A pre-configured SSL Context.</em> <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> SSLContext context) +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> implicit, <strong class="jxr_keyword">final</strong> SSLContext ctx) <a class="jxr_linenumber" name="L156" href="#L156">156</a> { -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">this</strong>(false, context); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">this</strong>(DEFAULT_PROTOCOL, implicit, ctx); <a class="jxr_linenumber" name="L158" href="#L158">158</a> } <a class="jxr_linenumber" name="L159" href="#L159">159</a> <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Because there are so many connect() methods,</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * the _connectAction_() method is provided as a means of performing</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * some action immediately after establishing a connection,</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * rather than reimplementing all of the connect() methods.</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @throws IOException If it is thrown by _connectAction_().</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.SocketClient#_connectAction_()</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Override -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> _connectAction_() <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L170" href="#L170">170</a> { -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_comment">// Implicit mode.</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> (isImplicit) { -<a class="jxr_linenumber" name="L173" href="#L173">173</a> performSSLNegotiation(); -<a class="jxr_linenumber" name="L174" href="#L174">174</a> } -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">super</strong>._connectAction_(); -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_comment">// Explicit mode - don't do anything. The user calls execTLS()</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> } -<a class="jxr_linenumber" name="L178" href="#L178">178</a> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * Performs a lazy init of the SSL context.</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @throws IOException When could not initialize the SSL context.</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initSSLContext() <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L184" href="#L184">184</a> { -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> (context == <strong class="jxr_keyword">null</strong>) -<a class="jxr_linenumber" name="L186" href="#L186">186</a> { -<a class="jxr_linenumber" name="L187" href="#L187">187</a> context = SSLContextUtils.createSSLContext(protocol, getKeyManager(), getTrustManager()); -<a class="jxr_linenumber" name="L188" href="#L188">188</a> } -<a class="jxr_linenumber" name="L189" href="#L189">189</a> } -<a class="jxr_linenumber" name="L190" href="#L190">190</a> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * SSL/TLS negotiation. Acquires an SSL socket of a</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * connection and carries out handshake processing.</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @throws IOException If server negotiation fails.</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> performSSLNegotiation() <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L197" href="#L197">197</a> { -<a class="jxr_linenumber" name="L198" href="#L198">198</a> initSSLContext(); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Constructor for IMAPSClient.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @param context A pre-configured SSL Context.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <a name="IMAPSClient" href="../../../../../org/apache/commons/net/imap/IMAPSClient.html#IMAPSClient">IMAPSClient</a>(<strong class="jxr_keyword">final</strong> SSLContext context) +<a class="jxr_linenumber" name="L165" href="#L165">165</a> { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">this</strong>(false, context); +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * Because there are so many connect() methods,</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * the _connectAction_() method is provided as a means of performing</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * some action immediately after establishing a connection,</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * rather than reimplementing all of the connect() methods.</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @throws IOException If it is thrown by _connectAction_().</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.SocketClient#_connectAction_()</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> @Override +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> _connectAction_() <strong class="jxr_keyword">throws</strong> IOException +<a class="jxr_linenumber" name="L179" href="#L179">179</a> { +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_comment">// Implicit mode.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> (isImplicit) { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> performSSLNegotiation(); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">super</strong>._connectAction_(); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_comment">// Explicit mode - don't do anything. The user calls execTLS()</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> } +<a class="jxr_linenumber" name="L187" href="#L187">187</a> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * Performs a lazy init of the SSL context.</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @throws IOException When could not initialize the SSL context.</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initSSLContext() <strong class="jxr_keyword">throws</strong> IOException +<a class="jxr_linenumber" name="L193" href="#L193">193</a> { +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">if</strong> (context == <strong class="jxr_keyword">null</strong>) +<a class="jxr_linenumber" name="L195" href="#L195">195</a> { +<a class="jxr_linenumber" name="L196" href="#L196">196</a> context = SSLContextUtils.createSSLContext(protocol, getKeyManager(), getTrustManager()); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } <a class="jxr_linenumber" name="L199" href="#L199">199</a> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">final</strong> SSLSocketFactory ssf = context.getSocketFactory(); -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">final</strong> String host = _hostname_ != <strong class="jxr_keyword">null</strong> ? _hostname_ : getRemoteAddress().getHostAddress(); -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> port = getRemotePort(); -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">final</strong> SSLSocket socket = -<a class="jxr_linenumber" name="L204" href="#L204">204</a> (SSLSocket) ssf.createSocket(_socket_, host, port, <strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> socket.setEnableSessionCreation(<strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> socket.setUseClientMode(<strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">if</strong> (tlsEndpointChecking) { -<a class="jxr_linenumber" name="L209" href="#L209">209</a> SSLSocketUtils.enableEndpointNameVerification(socket); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (protocols != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> socket.setEnabledProtocols(protocols); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> } -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">if</strong> (suites != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L216" href="#L216">216</a> socket.setEnabledCipherSuites(suites); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> } -<a class="jxr_linenumber" name="L218" href="#L218">218</a> socket.startHandshake(); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">// TODO the following setup appears to duplicate that in the super class methods</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> _socket_ = socket; -<a class="jxr_linenumber" name="L222" href="#L222">222</a> _input_ = socket.getInputStream(); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> _output_ = socket.getOutputStream(); -<a class="jxr_linenumber" name="L224" href="#L224">224</a> _reader = -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">new</strong> <a name="CRLFLineReader" href="../../../../../org/apache/commons/net/io/CRLFLineReader.html#CRLFLineReader">CRLFLineReader</a>(<strong class="jxr_keyword">new</strong> InputStreamReader(_input_, -<a class="jxr_linenumber" name="L226" href="#L226">226</a> __DEFAULT_ENCODING)); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> __writer = -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">new</strong> BufferedWriter(<strong class="jxr_keyword">new</strong> OutputStreamWriter(_output_, -<a class="jxr_linenumber" name="L229" href="#L229">229</a> __DEFAULT_ENCODING)); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (hostnameVerifier != <strong class="jxr_keyword">null</strong> && !hostnameVerifier.verify(host, socket.getSession())) { -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> SSLHandshakeException(<span class="jxr_string">"Hostname doesn't match certificate"</span>); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> } -<a class="jxr_linenumber" name="L234" href="#L234">234</a> } -<a class="jxr_linenumber" name="L235" href="#L235">235</a> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * Get the {@link KeyManager} instance.</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @return The current {@link KeyManager} instance.</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">private</strong> KeyManager getKeyManager() -<a class="jxr_linenumber" name="L241" href="#L241">241</a> { -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">return</strong> keyManager; +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * SSL/TLS negotiation. Acquires an SSL socket of a</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * connection and carries out handshake processing.</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @throws IOException If server negotiation fails.</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> performSSLNegotiation() <strong class="jxr_keyword">throws</strong> IOException +<a class="jxr_linenumber" name="L206" href="#L206">206</a> { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> initSSLContext(); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">final</strong> SSLSocketFactory ssf = context.getSocketFactory(); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">final</strong> String host = _hostname_ != <strong class="jxr_keyword">null</strong> ? _hostname_ : getRemoteAddress().getHostAddress(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> port = getRemotePort(); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">final</strong> SSLSocket socket = +<a class="jxr_linenumber" name="L213" href="#L213">213</a> (SSLSocket) ssf.createSocket(_socket_, host, port, <strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> socket.setEnableSessionCreation(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> socket.setUseClientMode(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (tlsEndpointChecking) { +<a class="jxr_linenumber" name="L218" href="#L218">218</a> SSLSocketUtils.enableEndpointNameVerification(socket); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> } +<a class="jxr_linenumber" name="L220" href="#L220">220</a> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (protocols != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L222" href="#L222">222</a> socket.setEnabledProtocols(protocols); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> } +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> (suites != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L225" href="#L225">225</a> socket.setEnabledCipherSuites(suites); +<a class="jxr_linenumber" name="L226" href="#L226">226</a> } +<a class="jxr_linenumber" name="L227" href="#L227">227</a> socket.startHandshake(); +<a class="jxr_linenumber" name="L228" href="#L228">228</a> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_comment">// TODO the following setup appears to duplicate that in the super class methods</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> _socket_ = socket; +<a class="jxr_linenumber" name="L231" href="#L231">231</a> _input_ = socket.getInputStream(); +<a class="jxr_linenumber" name="L232" href="#L232">232</a> _output_ = socket.getOutputStream(); +<a class="jxr_linenumber" name="L233" href="#L233">233</a> _reader = +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">new</strong> <a name="CRLFLineReader" href="../../../../../org/apache/commons/net/io/CRLFLineReader.html#CRLFLineReader">CRLFLineReader</a>(<strong class="jxr_keyword">new</strong> InputStreamReader(_input_, +<a class="jxr_linenumber" name="L235" href="#L235">235</a> __DEFAULT_ENCODING)); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> __writer = +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">new</strong> BufferedWriter(<strong class="jxr_keyword">new</strong> OutputStreamWriter(_output_, +<a class="jxr_linenumber" name="L238" href="#L238">238</a> __DEFAULT_ENCODING)); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (hostnameVerifier != <strong class="jxr_keyword">null</strong> && !hostnameVerifier.verify(host, socket.getSession())) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> SSLHandshakeException(<span class="jxr_string">"Hostname doesn't match certificate"</span>); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> } <a class="jxr_linenumber" name="L243" href="#L243">243</a> } <a class="jxr_linenumber" name="L244" href="#L244">244</a> <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * Set a {@link KeyManager} to use.</em> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param newKeyManager The KeyManager implementation to set.</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.util.KeyManagerUtils</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyManager(<strong class="jxr_keyword">final</strong> KeyManager newKeyManager) -<a class="jxr_linenumber" name="L251" href="#L251">251</a> { -<a class="jxr_linenumber" name="L252" href="#L252">252</a> keyManager = newKeyManager; -<a class="jxr_linenumber" name="L253" href="#L253">253</a> } -<a class="jxr_linenumber" name="L254" href="#L254">254</a> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * Controls which particular cipher suites are enabled for use on this</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * connection. Called before server negotiation.</em> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param cipherSuites The cipher suites.</em> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledCipherSuites(<strong class="jxr_keyword">final</strong> String[] cipherSuites) -<a class="jxr_linenumber" name="L261" href="#L261">261</a> { -<a class="jxr_linenumber" name="L262" href="#L262">262</a> suites = <strong class="jxr_keyword">new</strong> String[cipherSuites.length]; -<a class="jxr_linenumber" name="L263" href="#L263">263</a> System.arraycopy(cipherSuites, 0, suites, 0, cipherSuites.length); -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } -<a class="jxr_linenumber" name="L265" href="#L265">265</a> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Returns the names of the cipher suites which could be enabled</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * for use on this connection.</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance, returns null.</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @return An array of cipher suite names, or <code>null</code>.</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">public</strong> String[] getEnabledCipherSuites() -<a class="jxr_linenumber" name="L273" href="#L273">273</a> { -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">if</strong> (_socket_ instanceof SSLSocket) -<a class="jxr_linenumber" name="L275" href="#L275">275</a> { -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> ((SSLSocket)_socket_).getEnabledCipherSuites(); -<a class="jxr_linenumber" name="L277" href="#L277">277</a> } -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L279" href="#L279">279</a> } -<a class="jxr_linenumber" name="L280" href="#L280">280</a> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * Controls which particular protocol versions are enabled for use on this</em> -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * connection. I perform setting before a server negotiation.</em> -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * @param protocolVersions The protocol versions.</em> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledProtocols(<strong class="jxr_keyword">final</strong> String[] protocolVersions) -<a class="jxr_linenumber" name="L287" href="#L287">287</a> { -<a class="jxr_linenumber" name="L288" href="#L288">288</a> protocols = <strong class="jxr_keyword">new</strong> String[protocolVersions.length]; -<a class="jxr_linenumber" name="L289" href="#L289">289</a> System.arraycopy(protocolVersions, 0, protocols, 0, protocolVersions.length); -<a class="jxr_linenumber" name="L290" href="#L290">290</a> } -<a class="jxr_linenumber" name="L291" href="#L291">291</a> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * Returns the names of the protocol versions which are currently</em> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * enabled for use on this connection.</em> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance, returns null.</em> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @return An array of protocols, or <code>null</code>.</em> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">public</strong> String[] getEnabledProtocols() -<a class="jxr_linenumber" name="L299" href="#L299">299</a> { -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">if</strong> (_socket_ instanceof SSLSocket) -<a class="jxr_linenumber" name="L301" href="#L301">301</a> { -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">return</strong> ((SSLSocket)_socket_).getEnabledProtocols(); -<a class="jxr_linenumber" name="L303" href="#L303">303</a> } -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L305" href="#L305">305</a> } -<a class="jxr_linenumber" name="L306" href="#L306">306</a> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * The TLS command execution.</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * @throws SSLException If the server reply code is not positive.</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * @throws IOException If an I/O error occurs while sending</em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * the command or performing the negotiation.</em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * @return TRUE if the command and negotiation succeeded.</em> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> execTLS() <strong class="jxr_keyword">throws</strong> SSLException, IOException -<a class="jxr_linenumber" name="L315" href="#L315">315</a> { -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">if</strong> (sendCommand(IMAPCommand.getCommand(IMAPCommand.STARTTLS)) != IMAPReply.OK) -<a class="jxr_linenumber" name="L317" href="#L317">317</a> { -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_comment">//throw new SSLException(getReplyString());</em> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> } -<a class="jxr_linenumber" name="L321" href="#L321">321</a> performSSLNegotiation(); -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L323" href="#L323">323</a> } -<a class="jxr_linenumber" name="L324" href="#L324">324</a> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * Get the currently configured {@link TrustManager}.</em> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * @return A TrustManager instance.</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">public</strong> TrustManager getTrustManager() -<a class="jxr_linenumber" name="L330" href="#L330">330</a> { -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">return</strong> trustManager; +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * Get the {@link KeyManager} instance.</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @return The current {@link KeyManager} instance.</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">private</strong> KeyManager getKeyManager() +<a class="jxr_linenumber" name="L250" href="#L250">250</a> { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">return</strong> keyManager; +<a class="jxr_linenumber" name="L252" href="#L252">252</a> } +<a class="jxr_linenumber" name="L253" href="#L253">253</a> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * Set a {@link KeyManager} to use.</em> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @param newKeyManager The KeyManager implementation to set.</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.util.KeyManagerUtils</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyManager(<strong class="jxr_keyword">final</strong> KeyManager newKeyManager) +<a class="jxr_linenumber" name="L260" href="#L260">260</a> { +<a class="jxr_linenumber" name="L261" href="#L261">261</a> keyManager = newKeyManager; +<a class="jxr_linenumber" name="L262" href="#L262">262</a> } +<a class="jxr_linenumber" name="L263" href="#L263">263</a> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Controls which particular cipher suites are enabled for use on this</em> +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * connection. Called before server negotiation.</em> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @param cipherSuites The cipher suites.</em> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledCipherSuites(<strong class="jxr_keyword">final</strong> String[] cipherSuites) +<a class="jxr_linenumber" name="L270" href="#L270">270</a> { +<a class="jxr_linenumber" name="L271" href="#L271">271</a> suites = <strong class="jxr_keyword">new</strong> String[cipherSuites.length]; +<a class="jxr_linenumber" name="L272" href="#L272">272</a> System.arraycopy(cipherSuites, 0, suites, 0, cipherSuites.length); +<a class="jxr_linenumber" name="L273" href="#L273">273</a> } +<a class="jxr_linenumber" name="L274" href="#L274">274</a> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * Returns the names of the cipher suites which could be enabled</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * for use on this connection.</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance, returns null.</em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @return An array of cipher suite names, or <code>null</code>.</em> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">public</strong> String[] getEnabledCipherSuites() +<a class="jxr_linenumber" name="L282" href="#L282">282</a> { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> (_socket_ instanceof SSLSocket) +<a class="jxr_linenumber" name="L284" href="#L284">284</a> { +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> ((SSLSocket)_socket_).getEnabledCipherSuites(); +<a class="jxr_linenumber" name="L286" href="#L286">286</a> } +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * Controls which particular protocol versions are enabled for use on this</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * connection. I perform setting before a server negotiation.</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param protocolVersions The protocol versions.</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledProtocols(<strong class="jxr_keyword">final</strong> String[] protocolVersions) +<a class="jxr_linenumber" name="L296" href="#L296">296</a> { +<a class="jxr_linenumber" name="L297" href="#L297">297</a> protocols = <strong class="jxr_keyword">new</strong> String[protocolVersions.length]; +<a class="jxr_linenumber" name="L298" href="#L298">298</a> System.arraycopy(protocolVersions, 0, protocols, 0, protocolVersions.length); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> } +<a class="jxr_linenumber" name="L300" href="#L300">300</a> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * Returns the names of the protocol versions which are currently</em> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * enabled for use on this connection.</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance, returns null.</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * @return An array of protocols, or <code>null</code>.</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">public</strong> String[] getEnabledProtocols() +<a class="jxr_linenumber" name="L308" href="#L308">308</a> { +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">if</strong> (_socket_ instanceof SSLSocket) +<a class="jxr_linenumber" name="L310" href="#L310">310</a> { +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">return</strong> ((SSLSocket)_socket_).getEnabledProtocols(); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> } +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L314" href="#L314">314</a> } +<a class="jxr_linenumber" name="L315" href="#L315">315</a> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * The TLS command execution.</em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @throws SSLException If the server reply code is not positive.</em> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @throws IOException If an I/O error occurs while sending</em> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * the command or performing the negotiation.</em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * @return TRUE if the command and negotiation succeeded.</em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> execTLS() <strong class="jxr_keyword">throws</strong> SSLException, IOException +<a class="jxr_linenumber" name="L324" href="#L324">324</a> { +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (sendCommand(IMAPCommand.getCommand(IMAPCommand.STARTTLS)) != IMAPReply.OK) +<a class="jxr_linenumber" name="L326" href="#L326">326</a> { +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_comment">//throw new SSLException(getReplyString());</em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> } +<a class="jxr_linenumber" name="L330" href="#L330">330</a> performSSLNegotiation(); +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <a class="jxr_linenumber" name="L332" href="#L332">332</a> } <a class="jxr_linenumber" name="L333" href="#L333">333</a> <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * Override the default {@link TrustManager} to use.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param newTrustManager The TrustManager implementation to set.</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.util.TrustManagerUtils</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTrustManager(<strong class="jxr_keyword">final</strong> TrustManager newTrustManager) -<a class="jxr_linenumber" name="L340" href="#L340">340</a> { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> trustManager = newTrustManager; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * Get the currently configured {@link HostnameVerifier}.</em> -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @return A HostnameVerifier instance.</em> -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @since 3.4</em> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">public</strong> HostnameVerifier getHostnameVerifier() -<a class="jxr_linenumber" name="L350" href="#L350">350</a> { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">return</strong> hostnameVerifier; -<a class="jxr_linenumber" name="L352" href="#L352">352</a> } -<a class="jxr_linenumber" name="L353" href="#L353">353</a> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * Override the default {@link HostnameVerifier} to use.</em> -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * @param newHostnameVerifier The HostnameVerifier implementation to set or <code>null</code> to disable.</em> -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @since 3.4</em> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHostnameVerifier(<strong class="jxr_keyword">final</strong> HostnameVerifier newHostnameVerifier) -<a class="jxr_linenumber" name="L360" href="#L360">360</a> { -<a class="jxr_linenumber" name="L361" href="#L361">361</a> hostnameVerifier = newHostnameVerifier; -<a class="jxr_linenumber" name="L362" href="#L362">362</a> } -<a class="jxr_linenumber" name="L363" href="#L363">363</a> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * Return whether or not endpoint identification using the HTTPS algorithm</em> -<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * on Java 1.7+ is enabled. The default behavior is for this to be disabled.</em> -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * @return True if enabled, false if not.</em> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @since 3.4</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEndpointCheckingEnabled() -<a class="jxr_linenumber" name="L372" href="#L372">372</a> { -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">return</strong> tlsEndpointChecking; -<a class="jxr_linenumber" name="L374" href="#L374">374</a> } -<a class="jxr_linenumber" name="L375" href="#L375">375</a> -<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * Automatic endpoint identification checking using the HTTPS algorithm</em> -<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * is supported on Java 1.7+. The default behavior is for this to be disabled.</em> -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * @param enable Enable automatic endpoint identification checking using the HTTPS algorithm on Java 1.7+.</em> -<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * @since 3.4</em> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEndpointCheckingEnabled(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> enable) -<a class="jxr_linenumber" name="L384" href="#L384">384</a> { -<a class="jxr_linenumber" name="L385" href="#L385">385</a> tlsEndpointChecking = enable; -<a class="jxr_linenumber" name="L386" href="#L386">386</a> } -<a class="jxr_linenumber" name="L387" href="#L387">387</a> } -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_comment">/* kate: indent-width 4; replace-tabs on; */</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * Get the currently configured {@link TrustManager}.</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @return A TrustManager instance.</em> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">public</strong> TrustManager getTrustManager() +<a class="jxr_linenumber" name="L339" href="#L339">339</a> { +<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">return</strong> trustManager; +<a class="jxr_linenumber" name="L341" href="#L341">341</a> } +<a class="jxr_linenumber" name="L342" href="#L342">342</a> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * Override the default {@link TrustManager} to use.</em> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * @param newTrustManager The TrustManager implementation to set.</em> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @see org.apache.commons.net.util.TrustManagerUtils</em> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTrustManager(<strong class="jxr_keyword">final</strong> TrustManager newTrustManager) +<a class="jxr_linenumber" name="L349" href="#L349">349</a> { +<a class="jxr_linenumber" name="L350" href="#L350">350</a> trustManager = newTrustManager; +<a class="jxr_linenumber" name="L351" href="#L351">351</a> } +<a class="jxr_linenumber" name="L352" href="#L352">352</a> +<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * Get the currently configured {@link HostnameVerifier}.</em> +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * @return A HostnameVerifier instance.</em> +<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * @since 3.4</em> +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">public</strong> HostnameVerifier getHostnameVerifier() +<a class="jxr_linenumber" name="L359" href="#L359">359</a> { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">return</strong> hostnameVerifier; +<a class="jxr_linenumber" name="L361" href="#L361">361</a> } +<a class="jxr_linenumber" name="L362" href="#L362">362</a> +<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> * Override the default {@link HostnameVerifier} to use.</em> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * @param newHostnameVerifier The HostnameVerifier implementation to set or <code>null</code> to disable.</em> +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * @since 3.4</em> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHostnameVerifier(<strong class="jxr_keyword">final</strong> HostnameVerifier newHostnameVerifier) +<a class="jxr_linenumber" name="L369" href="#L369">369</a> { +<a class="jxr_linenumber" name="L370" href="#L370">370</a> hostnameVerifier = newHostnameVerifier; +<a class="jxr_linenumber" name="L371" href="#L371">371</a> } +<a class="jxr_linenumber" name="L372" href="#L372">372</a> +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * Return whether or not endpoint identification using the HTTPS algorithm</em> +<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * on Java 1.7+ is enabled. The default behavior is for this to be disabled.</em> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * @return True if enabled, false if not.</em> +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * @since 3.4</em> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEndpointCheckingEnabled() +<a class="jxr_linenumber" name="L381" href="#L381">381</a> { +<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">return</strong> tlsEndpointChecking; +<a class="jxr_linenumber" name="L383" href="#L383">383</a> } +<a class="jxr_linenumber" name="L384" href="#L384">384</a> +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * Automatic endpoint identification checking using the HTTPS algorithm</em> +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * is supported on Java 1.7+. The default behavior is for this to be disabled.</em> +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * @param enable Enable automatic endpoint identification checking using the HTTPS algorithm on Java 1.7+.</em> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * @since 3.4</em> +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEndpointCheckingEnabled(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> enable) +<a class="jxr_linenumber" name="L393" href="#L393">393</a> { +<a class="jxr_linenumber" name="L394" href="#L394">394</a> tlsEndpointChecking = enable; +<a class="jxr_linenumber" name="L395" href="#L395">395</a> } +<a class="jxr_linenumber" name="L396" href="#L396">396</a> } +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_comment">/* kate: indent-width 4; replace-tabs on; */</em> </pre> <hr/> <div id="footer">Copyright © 2001–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/package-frame.html ============================================================================== --- websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/package-frame.html (original) +++ websites/production/commons/content/proper/commons-net/xref/org/apache/commons/net/imap/package-frame.html Sun Oct 18 14:48:36 2020 @@ -4,7 +4,7 @@ <!-- generated by Apache Maven JXR (jdk8) --> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>Apache Commons Net 3.7.1 Reference Package org.apache.commons.net.imap</title> + <title>Apache Commons Net 3.7.2 Reference Package org.apache.commons.net.imap</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> </head> <body>