sslfilter.html

MINA+API 关于MINA的API

<a name="237" href="#237">237</a>     <em class="jxr_javadoccomment">/**</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * Stops the SSL session by sending TLS &lt;tt&gt;close_notify&lt;/tt&gt; message to</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * initiate TLS closure.</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     *</em>
<a name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * @param session the {@link IoSession} to initiate TLS closure</em>
<a name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * @throws SSLException if failed to initiate TLS closure</em>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if this filter is not managing the specified session</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     */</em>
<a name="245" href="#245">245</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> stopSsl(<a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session) <strong class="jxr_keyword">throws</strong> SSLException {
<a name="246" href="#246">246</a>         <a href="../../../../../org/apache/mina/filter/ssl/SslHandler.html">SslHandler</a> handler = getSslSessionHandler(session);
<a name="247" href="#247">247</a>         <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter = (NextFilter) session.getAttribute(NEXT_FILTER);
<a name="248" href="#248">248</a>         <a href="../../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> future;
<a name="249" href="#249">249</a>         <strong class="jxr_keyword">synchronized</strong> (handler) {
<a name="250" href="#250">250</a>             future = initiateClosure(nextFilter, session);
<a name="251" href="#251">251</a>         }
<a name="252" href="#252">252</a> 
<a name="253" href="#253">253</a>         handler.flushScheduledEvents();
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>         <strong class="jxr_keyword">return</strong> future;
<a name="256" href="#256">256</a>     }
<a name="257" href="#257">257</a> 
<a name="258" href="#258">258</a>     <em class="jxr_javadoccomment">/**</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if the engine is set to use client mode</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     * when handshaking.</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     */</em>
<a name="262" href="#262">262</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isUseClientMode() {
<a name="263" href="#263">263</a>         <strong class="jxr_keyword">return</strong> client;
<a name="264" href="#264">264</a>     }
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>     <em class="jxr_javadoccomment">/**</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * Configures the engine to use client (or server) mode when handshaking.</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     */</em>
<a name="269" href="#269">269</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUseClientMode(<strong class="jxr_keyword">boolean</strong> clientMode) {
<a name="270" href="#270">270</a>         <strong class="jxr_keyword">this</strong>.client = clientMode;
<a name="271" href="#271">271</a>     }
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a>     <em class="jxr_javadoccomment">/**</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if the engine will &lt;em&gt;require&lt;/em&gt; client authentication.</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * This option is only useful to engines in the server mode.</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     */</em>
<a name="277" href="#277">277</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isNeedClientAuth() {
<a name="278" href="#278">278</a>         <strong class="jxr_keyword">return</strong> needClientAuth;
<a name="279" href="#279">279</a>     }
<a name="280" href="#280">280</a> 
<a name="281" href="#281">281</a>     <em class="jxr_javadoccomment">/**</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * Configures the engine to &lt;em&gt;require&lt;/em&gt; client authentication.</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * This option is only useful for engines in the server mode.</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     */</em>
<a name="285" href="#285">285</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNeedClientAuth(<strong class="jxr_keyword">boolean</strong> needClientAuth) {
<a name="286" href="#286">286</a>         <strong class="jxr_keyword">this</strong>.needClientAuth = needClientAuth;
<a name="287" href="#287">287</a>     }
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a>     <em class="jxr_javadoccomment">/**</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if the engine will &lt;em&gt;request&lt;/em&gt; client authentication.</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * This option is only useful to engines in the server mode.</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     */</em>
<a name="293" href="#293">293</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isWantClientAuth() {
<a name="294" href="#294">294</a>         <strong class="jxr_keyword">return</strong> wantClientAuth;
<a name="295" href="#295">295</a>     }
<a name="296" href="#296">296</a> 
<a name="297" href="#297">297</a>     <em class="jxr_javadoccomment">/**</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * Configures the engine to &lt;em&gt;request&lt;/em&gt; client authentication.</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * This option is only useful for engines in the server mode.</em>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     */</em>
<a name="301" href="#301">301</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWantClientAuth(<strong class="jxr_keyword">boolean</strong> wantClientAuth) {
<a name="302" href="#302">302</a>         <strong class="jxr_keyword">this</strong>.wantClientAuth = wantClientAuth;
<a name="303" href="#303">303</a>     }
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>     <em class="jxr_javadoccomment">/**</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">     * Returns the list of cipher suites to be enabled when {@link SSLEngine}</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * is initialized.</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     *</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * @return &lt;tt&gt;null&lt;/tt&gt; means 'use {@link SSLEngine}'s default.'</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     */</em>
<a name="311" href="#311">311</a>     <strong class="jxr_keyword">public</strong> String[] getEnabledCipherSuites() {
<a name="312" href="#312">312</a>         <strong class="jxr_keyword">return</strong> enabledCipherSuites;
<a name="313" href="#313">313</a>     }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a>     <em class="jxr_javadoccomment">/**</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     * Sets the list of cipher suites to be enabled when {@link SSLEngine}</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * is initialized.</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     *</em>
<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">     * @param cipherSuites &lt;tt&gt;null&lt;/tt&gt; means 'use {@link SSLEngine}'s default.'</em>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">     */</em>
<a name="321" href="#321">321</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledCipherSuites(String[] cipherSuites) {
<a name="322" href="#322">322</a>         <strong class="jxr_keyword">this</strong>.enabledCipherSuites = cipherSuites;
<a name="323" href="#323">323</a>     }
<a name="324" href="#324">324</a> 
<a name="325" href="#325">325</a>     <em class="jxr_javadoccomment">/**</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">     * Returns the list of protocols to be enabled when {@link SSLEngine}</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     * is initialized.</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     *</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * @return &lt;tt&gt;null&lt;/tt&gt; means 'use {@link SSLEngine}'s default.'</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     */</em>
<a name="331" href="#331">331</a>     <strong class="jxr_keyword">public</strong> String[] getEnabledProtocols() {
<a name="332" href="#332">332</a>         <strong class="jxr_keyword">return</strong> enabledProtocols;
<a name="333" href="#333">333</a>     }
<a name="334" href="#334">334</a> 
<a name="335" href="#335">335</a>     <em class="jxr_javadoccomment">/**</em>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * Sets the list of protocols to be enabled when {@link SSLEngine}</em>
<a name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * is initialized.</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     *</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">     * @param protocols &lt;tt&gt;null&lt;/tt&gt; means 'use {@link SSLEngine}'s default.'</em>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment">     */</em>
<a name="341" href="#341">341</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabledProtocols(String[] protocols) {
<a name="342" href="#342">342</a>         <strong class="jxr_keyword">this</strong>.enabledProtocols = protocols;
<a name="343" href="#343">343</a>     }
<a name="344" href="#344">344</a> 
<a name="345" href="#345">345</a>     @Override
<a name="346" href="#346">346</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onPreAdd(<a href="../../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> parent, String name,
<a name="347" href="#347">347</a>             <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter) <strong class="jxr_keyword">throws</strong> SSLException {
<a name="348" href="#348">348</a>         <strong class="jxr_keyword">if</strong> (parent.contains(SslFilter.<strong class="jxr_keyword">class</strong>)) {
<a name="349" href="#349">349</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(
<a name="350" href="#350">350</a>                     <span class="jxr_string">"Only one "</span> + SslFilter.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" is permitted."</span>);
<a name="351" href="#351">351</a>         }
<a name="352" href="#352">352</a> 
<a name="353" href="#353">353</a>         <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session = parent.getSession();
<a name="354" href="#354">354</a>         session.setAttribute(NEXT_FILTER, nextFilter);
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>         <em class="jxr_comment">// Create an SSL handler and start handshake.</em>
<a name="357" href="#357">357</a>         <a href="../../../../../org/apache/mina/filter/ssl/SslHandler.html">SslHandler</a> handler = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslHandler.html">SslHandler</a>(<strong class="jxr_keyword">this</strong>, sslContext, session);
<a name="358" href="#358">358</a>         session.setAttribute(SSL_HANDLER, handler);
<a name="359" href="#359">359</a>     }