blob: 55c47e4a3a5896f61526e1c1f6cad8f8b4c53c09 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>HttpSmartProxyHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/mina/proxy/handlers/http/HttpSmartProxyHandler.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> *</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> */</em>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.proxy.handlers.http;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.filterchain.IoFilter.NextFilter;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.proxy.ProxyAuthException;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mina.proxy.session.ProxyIoSession;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mina.proxy.utils.StringUtilities;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * HttpSmartProxyHandler.java - HTTP proxy handler that automatically handles forwarding request </em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * to the appropriate authentication mechanism logic handler.</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * </em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @version $Rev: 685703 $, $Date: 2008-08-14 00:14:47 +0200 (Thu, 14 Aug 2008) $</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since MINA 2.0.0-M3</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/HttpSmartProxyHandler.html">HttpSmartProxyHandler</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.html">AbstractHttpLogicHandler</a> {
<a name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> Logger logger = LoggerFactory
<a name="43" href="#43">43</a> .getLogger(HttpSmartProxyHandler.<strong class="jxr_keyword">class</strong>);
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Has the HTTP proxy request been sent ?</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em>
<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> requestSent = false;
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * The automatically selected http authentication logic handler. </em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.html">AbstractAuthLogicHandler</a> authHandler;
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/HttpSmartProxyHandler.html">HttpSmartProxyHandler</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/proxy/session/ProxyIoSession.html">ProxyIoSession</a> proxyIoSession) {
<a name="56" href="#56">56</a> <strong class="jxr_keyword">super</strong>(proxyIoSession);
<a name="57" href="#57">57</a> }
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Perform any handshaking processing.</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doHandshake(<strong class="jxr_keyword">final</strong> NextFilter nextFilter)
<a name="63" href="#63">63</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a> {
<a name="64" href="#64">64</a> logger.debug(<span class="jxr_string">" doHandshake()"</span>);
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> <strong class="jxr_keyword">if</strong> (authHandler != <strong class="jxr_keyword">null</strong>) {
<a name="67" href="#67">67</a> authHandler.doHandshake(nextFilter);
<a name="68" href="#68">68</a> } <strong class="jxr_keyword">else</strong> {
<a name="69" href="#69">69</a> <strong class="jxr_keyword">if</strong> (requestSent) {
<a name="70" href="#70">70</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a>(
<a name="71" href="#71">71</a> <span class="jxr_string">"Authentication request already sent"</span>);
<a name="72" href="#72">72</a> }
<a name="73" href="#73">73</a>
<a name="74" href="#74">74</a> logger.debug(<span class="jxr_string">" sending HTTP request"</span>);
<a name="75" href="#75">75</a>
<a name="76" href="#76">76</a> <em class="jxr_comment">// Send request</em>
<a name="77" href="#77">77</a> <a href="../../../../../../org/apache/mina/proxy/handlers/http/HttpProxyRequest.html">HttpProxyRequest</a> req = (HttpProxyRequest) getProxyIoSession()
<a name="78" href="#78">78</a> .getRequest();
<a name="79" href="#79">79</a> Map&lt;String, List&lt;String&gt;&gt; headers = req.getHeaders() != <strong class="jxr_keyword">null</strong> ? req
<a name="80" href="#80">80</a> .getHeaders() : <strong class="jxr_keyword">new</strong> HashMap&lt;String, List&lt;String&gt;&gt;();
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> StringUtilities.addValueToHeader(headers, <span class="jxr_string">"Keep-Alive"</span>,
<a name="83" href="#83">83</a> HttpProxyConstants.DEFAULT_KEEP_ALIVE_TIME, <strong class="jxr_keyword">true</strong>);
<a name="84" href="#84">84</a> StringUtilities.addValueToHeader(headers, <span class="jxr_string">"Proxy-Connection"</span>,
<a name="85" href="#85">85</a> <span class="jxr_string">"keep-Alive"</span>, <strong class="jxr_keyword">true</strong>);
<a name="86" href="#86">86</a> req.setHeaders(headers);
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> writeRequest(nextFilter, req);
<a name="89" href="#89">89</a> requestSent = <strong class="jxr_keyword">true</strong>;
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * Automatic selection of the authentication algorithm. If &lt;code&gt;preferedOrder&lt;/code&gt; is set then</em>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * algorithms are selected from the list order otherwise the algorithm tries to select the most </em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * secured algorithm available first.</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> autoSelectAuthHandler(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/HttpProxyResponse.html">HttpProxyResponse</a> response)
<a name="99" href="#99">99</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a> {
<a name="100" href="#100">100</a> <em class="jxr_comment">// Get the Proxy-Authenticate header</em>
<a name="101" href="#101">101</a> List&lt;String&gt; values = response.getHeaders().get(<span class="jxr_string">"Proxy-Authenticate"</span>);
<a name="102" href="#102">102</a>
<a name="103" href="#103">103</a> <strong class="jxr_keyword">if</strong> (values == <strong class="jxr_keyword">null</strong> || values.size() == 0) {
<a name="104" href="#104">104</a> authHandler = HttpAuthenticationMethods.NO_AUTH
<a name="105" href="#105">105</a> .getNewHandler(getProxyIoSession());
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (getProxyIoSession().getPreferedOrder() == <strong class="jxr_keyword">null</strong>) {
<a name="108" href="#108">108</a> <strong class="jxr_keyword">for</strong> (String proxyAuthHeader : values) {
<a name="109" href="#109">109</a> proxyAuthHeader = proxyAuthHeader.toLowerCase();
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <strong class="jxr_keyword">try</strong> {
<a name="112" href="#112">112</a> <em class="jxr_comment">// Test which auth mechanism to use. First found is the first used that's why we test</em>
<a name="113" href="#113">113</a> <em class="jxr_comment">// in a decreasing security quality order.</em>
<a name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"ntlm"</span>)) {
<a name="115" href="#115">115</a> authHandler = HttpAuthenticationMethods.NTLM
<a name="116" href="#116">116</a> .getNewHandler(getProxyIoSession());
<a name="117" href="#117">117</a> <strong class="jxr_keyword">break</strong>;
<a name="118" href="#118">118</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"digest"</span>)) {
<a name="119" href="#119">119</a> authHandler = HttpAuthenticationMethods.DIGEST
<a name="120" href="#120">120</a> .getNewHandler(getProxyIoSession());
<a name="121" href="#121">121</a> <strong class="jxr_keyword">break</strong>;
<a name="122" href="#122">122</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"basic"</span>)) {
<a name="123" href="#123">123</a> authHandler = HttpAuthenticationMethods.BASIC
<a name="124" href="#124">124</a> .getNewHandler(getProxyIoSession());
<a name="125" href="#125">125</a> <strong class="jxr_keyword">break</strong>;
<a name="126" href="#126">126</a> }
<a name="127" href="#127">127</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a name="128" href="#128">128</a> logger.debug(<span class="jxr_string">"Following exception occured:"</span>, ex);
<a name="129" href="#129">129</a> }
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> (authHandler == <strong class="jxr_keyword">null</strong>) {
<a name="133" href="#133">133</a> authHandler = HttpAuthenticationMethods.NO_AUTH
<a name="134" href="#134">134</a> .getNewHandler(getProxyIoSession());
<a name="135" href="#135">135</a> }
<a name="136" href="#136">136</a>
<a name="137" href="#137">137</a> } <strong class="jxr_keyword">else</strong> {
<a name="138" href="#138">138</a> <strong class="jxr_keyword">for</strong> (HttpAuthenticationMethods method : getProxyIoSession()
<a name="139" href="#139">139</a> .getPreferedOrder()) {
<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (authHandler != <strong class="jxr_keyword">null</strong>) {
<a name="141" href="#141">141</a> <strong class="jxr_keyword">break</strong>;
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <strong class="jxr_keyword">if</strong> (method == HttpAuthenticationMethods.NO_AUTH) {
<a name="145" href="#145">145</a> authHandler = HttpAuthenticationMethods.NO_AUTH
<a name="146" href="#146">146</a> .getNewHandler(getProxyIoSession());
<a name="147" href="#147">147</a> <strong class="jxr_keyword">break</strong>;
<a name="148" href="#148">148</a> }
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">for</strong> (String proxyAuthHeader : values) {
<a name="151" href="#151">151</a> proxyAuthHeader = proxyAuthHeader.toLowerCase();
<a name="152" href="#152">152</a>
<a name="153" href="#153">153</a> <strong class="jxr_keyword">try</strong> {
<a name="154" href="#154">154</a> <em class="jxr_comment">// test which auth mechanism to use</em>
<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"basic"</span>)
<a name="156" href="#156">156</a> &amp;&amp; method == HttpAuthenticationMethods.BASIC) {
<a name="157" href="#157">157</a> authHandler = HttpAuthenticationMethods.BASIC
<a name="158" href="#158">158</a> .getNewHandler(getProxyIoSession());
<a name="159" href="#159">159</a> <strong class="jxr_keyword">break</strong>;
<a name="160" href="#160">160</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"digest"</span>)
<a name="161" href="#161">161</a> &amp;&amp; method == HttpAuthenticationMethods.DIGEST) {
<a name="162" href="#162">162</a> authHandler = HttpAuthenticationMethods.DIGEST
<a name="163" href="#163">163</a> .getNewHandler(getProxyIoSession());
<a name="164" href="#164">164</a> <strong class="jxr_keyword">break</strong>;
<a name="165" href="#165">165</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (proxyAuthHeader.contains(<span class="jxr_string">"ntlm"</span>)
<a name="166" href="#166">166</a> &amp;&amp; method == HttpAuthenticationMethods.NTLM) {
<a name="167" href="#167">167</a> authHandler = HttpAuthenticationMethods.NTLM
<a name="168" href="#168">168</a> .getNewHandler(getProxyIoSession());
<a name="169" href="#169">169</a> <strong class="jxr_keyword">break</strong>;
<a name="170" href="#170">170</a> }
<a name="171" href="#171">171</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a name="172" href="#172">172</a> logger.debug(<span class="jxr_string">"Following exception occured:"</span>, ex);
<a name="173" href="#173">173</a> }
<a name="174" href="#174">174</a> }
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> }
<a name="178" href="#178">178</a>
<a name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (authHandler == <strong class="jxr_keyword">null</strong>) {
<a name="180" href="#180">180</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a>(
<a name="181" href="#181">181</a> <span class="jxr_string">"Unknown authentication mechanism(s): "</span> + values);
<a name="182" href="#182">182</a> }
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * Handle a HTTP response from the proxy server.</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * </em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @param response The response.</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> */</em>
<a name="190" href="#190">190</a> @Override
<a name="191" href="#191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> handleResponse(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/http/HttpProxyResponse.html">HttpProxyResponse</a> response)
<a name="192" href="#192">192</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a> {
<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (!isHandshakeComplete()
<a name="194" href="#194">194</a> &amp;&amp; (<span class="jxr_string">"close"</span>.equalsIgnoreCase(<a href="../../../../../../org/apache/mina/proxy/utils/StringUtilities.html">StringUtilities</a>
<a name="195" href="#195">195</a> .getSingleValuedHeader(response.getHeaders(),
<a name="196" href="#196">196</a> <span class="jxr_string">"Proxy-Connection"</span>)) || <span class="jxr_string">"close"</span>
<a name="197" href="#197">197</a> .equalsIgnoreCase(<a href="../../../../../../org/apache/mina/proxy/utils/StringUtilities.html">StringUtilities</a>
<a name="198" href="#198">198</a> .getSingleValuedHeader(response.getHeaders(),
<a name="199" href="#199">199</a> <span class="jxr_string">"Connection"</span>)))) {
<a name="200" href="#200">200</a> getProxyIoSession().setReconnectionNeeded(<strong class="jxr_keyword">true</strong>);
<a name="201" href="#201">201</a> }
<a name="202" href="#202">202</a>
<a name="203" href="#203">203</a> <strong class="jxr_keyword">if</strong> (response.getStatusCode() == 407) {
<a name="204" href="#204">204</a> <strong class="jxr_keyword">if</strong> (authHandler == <strong class="jxr_keyword">null</strong>) {
<a name="205" href="#205">205</a> autoSelectAuthHandler(response);
<a name="206" href="#206">206</a> }
<a name="207" href="#207">207</a> authHandler.handleResponse(response);
<a name="208" href="#208">208</a> } <strong class="jxr_keyword">else</strong> {
<a name="209" href="#209">209</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/proxy/ProxyAuthException.html">ProxyAuthException</a>(<span class="jxr_string">"Received error response code ("</span>
<a name="210" href="#210">210</a> + response.getStatusLine() + <span class="jxr_string">")."</span>);
<a name="211" href="#211">211</a> }
<a name="212" href="#212">212</a> }
<a name="213" href="#213">213</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>