~testplan-team/testplan/source-collection

<a name="2" href="#2">2</a> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/ProxyClient.java,v 1.5 2004/12/20 11:39:04 olegk Exp $

<a name="3" href="#3">3</a> * $Revision: 480424 $

<a name="4" href="#4">4</a> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $

<a name="5" href="#5">5</a> *

<a name="6" href="#6">6</a> * ====================================================================

<a name="7" href="#7">7</a> *

<a name="8" href="#8">8</a> * Licensed to the Apache Software Foundation (ASF) under one or more

<a name="9" href="#9">9</a> * contributor license agreements. See the NOTICE file distributed with

<a name="10" href="#10">10</a> * this work for additional information regarding copyright ownership.

<a name="11" href="#11">11</a> * The ASF licenses this file to You under the Apache License, Version 2.0

<a name="12" href="#12">12</a> * (the "License"); you may not use this file except in compliance with

<a name="13" href="#13">13</a> * the License. You may obtain a copy of the License at

<a name="14" href="#14">14</a> *

<a name="15" href="#15">15</a> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a>

<a name="16" href="#16">16</a> *

<a name="17" href="#17">17</a> * Unless required by applicable law or agreed to in writing, software

<a name="18" href="#18">18</a> * distributed under the License is distributed on an "AS IS" BASIS,

<a name="19" href="#19">19</a> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

<a name="20" href="#20">20</a> * See the License for the specific language governing permissions and

<a name="21" href="#21">21</a> * limitations under the License.

<a name="22" href="#22">22</a> * ====================================================================

<a name="23" href="#23">23</a> *

<a name="24" href="#24">24</a> * This software consists of voluntary contributions made by many

<a name="25" href="#25">25</a> * individuals on behalf of the Apache Software Foundation. For more

<a name="26" href="#26">26</a> * information on the Apache Software Foundation, please see

<a name="27" href="#27">27</a> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.

<a name="28" href="#28">28</a> *

<a name="29" href="#29">29</a> */

<a name="31" href="#31">31</a> package org.apache.commons.httpclient;

<a name="33" href="#33">33</a> import java.io.IOException;

<a name="34" href="#34">34</a> import java.net.Socket;

<a name="36" href="#36">36</a> import org.apache.commons.httpclient.params.HttpClientParams;

<a name="37" href="#37">37</a> import org.apache.commons.httpclient.params.HttpConnectionManagerParams;

<a name="38" href="#38">38</a> import org.apache.commons.httpclient.params.HttpParams;

<a name="40" href="#40">40</a> /**

<a name="41" href="#41">41</a> * A client that provides {@link java.net.Socket sockets} for communicating through HTTP proxies

<a name="42" href="#42">42</a> * via the HTTP CONNECT method. This is primarily needed for non-HTTP protocols that wish to

<a name="43" href="#43">43</a> * communicate via an HTTP proxy.

<a name="44" href="#44">44</a> *

<a name="45" href="#45">45</a> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a>

<a name="46" href="#46">46</a> * @author Michael Becke

<a name="47" href="#47">47</a> *

<a name="48" href="#48">48</a> * @since 3.0

<a name="49" href="#49">49</a> *

<a name="50" href="#50">50</a> * @version $Revision: 480424 $

<a name="51" href="#51">51</a> */

<a name="52" href="#52">52</a> public class <a href="../../../../org/apache/commons/httpclient/ProxyClient.html">ProxyClient</a> {

<a name="54" href="#54">54</a> // ----------------------------------------------------- Instance Variables

<a name="56" href="#56">56</a> /**

<a name="57" href="#57">57</a> * The {@link HttpState HTTP state} associated with this ProxyClient.

<a name="58" href="#58">58</a> */

<a name="59" href="#59">59</a> private <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state = new <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a>();

<a name="61" href="#61">61</a> /**

<a name="62" href="#62">62</a> * The {@link HttpClientParams collection of parameters} associated with this ProxyClient.

<a name="63" href="#63">63</a> */

<a name="64" href="#64">64</a> private <a href="../../../../org/apache/commons/httpclient/params/HttpClientParams.html">HttpClientParams</a> params = null;

<a name="66" href="#66">66</a> /**

<a name="67" href="#67">67</a> * The {@link HostConfiguration host configuration} associated with

<a name="68" href="#68">68</a> * the ProxyClient

<a name="69" href="#69">69</a> */

<a name="70" href="#70">70</a> private <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration = new <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a>();

<a name="72" href="#72">72</a> /**

<a name="73" href="#73">73</a> * Creates an instance of ProxyClient using default {@link HttpClientParams parameter set}.

<a name="74" href="#74">74</a> *

<a name="75" href="#75">75</a> * @see HttpClientParams

<a name="76" href="#76">76</a> */

<a name="77" href="#77">77</a> public <a href="../../../../org/apache/commons/httpclient/ProxyClient.html">ProxyClient</a>() {

<a name="78" href="#78">78</a> this(new <a href="../../../../org/apache/commons/httpclient/params/HttpClientParams.html">HttpClientParams</a>());

<a name="79" href="#79">79</a> }

<a name="81" href="#81">81</a> /**

<a name="82" href="#82">82</a> * Creates an instance of ProxyClient using the given

<a name="83" href="#83">83</a> * {@link HttpClientParams parameter set}.

<a name="84" href="#84">84</a> *

<a name="85" href="#85">85</a> * @param params The {@link HttpClientParams parameters} to use.

<a name="86" href="#86">86</a> *

<a name="87" href="#87">87</a> * @see HttpClientParams

<a name="88" href="#88">88</a> */

<a name="89" href="#89">89</a> public <a href="../../../../org/apache/commons/httpclient/ProxyClient.html">ProxyClient</a>(<a href="../../../../org/apache/commons/httpclient/params/HttpClientParams.html">HttpClientParams</a> params) {

<a name="90" href="#90">90</a> super();

100

<a name="91" href="#91">91</a> if (params == null) {

101

<a name="92" href="#92">92</a> throw new IllegalArgumentException("Params may not be null");

102

<a name="93" href="#93">93</a> }

103

<a name="94" href="#94">94</a> this.params = params;

104

<a name="95" href="#95">95</a> }

105

106

<a name="97" href="#97">97</a> // ------------------------------------------------------------- Properties

107

108

<a name="99" href="#99">99</a> /**

109

<a name="100" href="#100">100</a> * Returns {@link HttpState HTTP state} associated with the ProxyClient.

110

<a name="101" href="#101">101</a> *

111

<a name="102" href="#102">102</a> * @see #setState(HttpState)

112

<a name="103" href="#103">103</a> * @return the shared client state

113

<a name="104" href="#104">104</a> */

114

<a name="105" href="#105">105</a> public synchronized <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> getState() {

115

<a name="106" href="#106">106</a> return state;

116

<a name="107" href="#107">107</a> }

117

118

<a name="109" href="#109">109</a> /**

119

<a name="110" href="#110">110</a> * Assigns {@link HttpState HTTP state} for the ProxyClient.

120

<a name="111" href="#111">111</a> *

121

<a name="112" href="#112">112</a> * @see #getState()

122

<a name="113" href="#113">113</a> * @param state the new {@link HttpState HTTP state} for the client

123

<a name="114" href="#114">114</a> */

124

<a name="115" href="#115">115</a> public synchronized void setState(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state) {

125

<a name="116" href="#116">116</a> this.state = state;

126

<a name="117" href="#117">117</a> }

127

128

<a name="119" href="#119">119</a> /**

129

<a name="120" href="#120">120</a> * Returns the {@link HostConfiguration host configuration} associated with the

130

<a name="121" href="#121">121</a> * ProxyClient.

131

<a name="122" href="#122">122</a> *

132

<a name="123" href="#123">123</a> * @return {@link HostConfiguration host configuration}

133

<a name="124" href="#124">124</a> */

134

<a name="125" href="#125">125</a> public synchronized <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> getHostConfiguration() {

135

<a name="126" href="#126">126</a> return hostConfiguration;

136

<a name="127" href="#127">127</a> }

137

138

<a name="129" href="#129">129</a> /**

139

<a name="130" href="#130">130</a> * Assigns the {@link HostConfiguration host configuration} to use with the

140

<a name="131" href="#131">131</a> * ProxyClient.

141

<a name="132" href="#132">132</a> *

142

<a name="133" href="#133">133</a> * @param hostConfiguration The {@link HostConfiguration host configuration} to set

143

<a name="134" href="#134">134</a> */

144

<a name="135" href="#135">135</a> public synchronized void setHostConfiguration(<a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration) {

145

<a name="136" href="#136">136</a> this.hostConfiguration = hostConfiguration;

146

<a name="137" href="#137">137</a> }

147

148

<a name="139" href="#139">139</a> /**

149

<a name="140" href="#140">140</a> * Returns {@link HttpClientParams HTTP protocol parameters} associated with this ProxyClient.

150

<a name="141" href="#141">141</a> *

151

<a name="142" href="#142">142</a> * @see HttpClientParams

152

<a name="143" href="#143">143</a> */

153

<a name="144" href="#144">144</a> public synchronized <a href="../../../../org/apache/commons/httpclient/params/HttpClientParams.html">HttpClientParams</a> getParams() {

154

<a name="145" href="#145">145</a> return this.params;

155

<a name="146" href="#146">146</a> }

156

157

<a name="148" href="#148">148</a> /**

158

<a name="149" href="#149">149</a> * Assigns {@link HttpClientParams HTTP protocol parameters} for this ProxyClient.

159

<a name="150" href="#150">150</a> *

160

<a name="151" href="#151">151</a> * @see HttpClientParams

161

<a name="152" href="#152">152</a> */

162

<a name="153" href="#153">153</a> public synchronized void setParams(final <a href="../../../../org/apache/commons/httpclient/params/HttpClientParams.html">HttpClientParams</a> params) {

163

<a name="154" href="#154">154</a> if (params == null) {

164

<a name="155" href="#155">155</a> throw new IllegalArgumentException("Parameters may not be null");

165

<a name="156" href="#156">156</a> }

166

<a name="157" href="#157">157</a> this.params = params;

167

<a name="158" href="#158">158</a> }

168

169

<a name="160" href="#160">160</a> /**

170

<a name="161" href="#161">161</a> * Creates a socket that is connected, via the HTTP CONNECT method, to a proxy.

171

<a name="162" href="#162">162</a> *

172

<a name="163" href="#163">163</a> *

173

<a name="164" href="#164">164</a> * Even though HTTP CONNECT proxying is generally used for HTTPS tunneling, the returned

174

<a name="165" href="#165">165</a> * socket will not have been wrapped in an SSL socket.

175

<a name="166" href="#166">166</a> *

176

<a name="167" href="#167">167</a> *

177

<a name="168" href="#168">168</a> *

178

<a name="169" href="#169">169</a> * Both the proxy and destination hosts must be set via the

179

<a name="170" href="#170">170</a> * {@link #getHostConfiguration() host configuration} prior to calling this method.

180

<a name="171" href="#171">171</a> *

181

<a name="172" href="#172">172</a> *

182

<a name="173" href="#173">173</a> * @return the connect response

183

<a name="174" href="#174">174</a> *

184

<a name="175" href="#175">175</a> * @throws IOException

185

<a name="176" href="#176">176</a> * @throws HttpException

186

<a name="177" href="#177">177</a> *

187

<a name="178" href="#178">178</a> * @see #getHostConfiguration()

188

<a name="179" href="#179">179</a> */

189

<a name="180" href="#180">180</a> public ConnectResponse connect() throws IOException, HttpException {

190

191

<a name="182" href="#182">182</a> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostconf = getHostConfiguration();

192

<a name="183" href="#183">183</a> if (hostconf.getProxyHost() == null) {

193

<a name="184" href="#184">184</a> throw new IllegalStateException("proxy host must be configured");

194

<a name="185" href="#185">185</a> }

195

<a name="186" href="#186">186</a> if (hostconf.getHost() == null) {

196

<a name="187" href="#187">187</a> throw new IllegalStateException("destination host must be configured");

197

<a name="188" href="#188">188</a> }

198

<a name="189" href="#189">189</a> if (hostconf.getProtocol().isSecure()) {

199

<a name="190" href="#190">190</a> throw new IllegalStateException("secure protocol socket factory may not be used");

200

<a name="191" href="#191">191</a> }

201

202

<a name="193" href="#193">193</a> <a href="../../../../org/apache/commons/httpclient/ConnectMethod.html">ConnectMethod</a> method = new <a href="../../../../org/apache/commons/httpclient/ConnectMethod.html">ConnectMethod</a>(getHostConfiguration());

203

<a name="194" href="#194">194</a> method.getParams().setDefaults(getParams());

204

205

<a name="196" href="#196">196</a> DummyConnectionManager connectionManager = new DummyConnectionManager();

206

<a name="197" href="#197">197</a> connectionManager.setConnectionParams(getParams());

207

208

<a name="199" href="#199">199</a> <a href="../../../../org/apache/commons/httpclient/HttpMethodDirector.html">HttpMethodDirector</a> director = new <a href="../../../../org/apache/commons/httpclient/HttpMethodDirector.html">HttpMethodDirector</a>(

209

<a name="200" href="#200">200</a> connectionManager,

210

<a name="201" href="#201">201</a> hostconf,

211

<a name="202" href="#202">202</a> getParams(),

212

<a name="203" href="#203">203</a> getState()

213

<a name="204" href="#204">204</a> );

214

215

<a name="206" href="#206">206</a> director.executeMethod(method);

216

217

<a name="208" href="#208">208</a> ConnectResponse response = new ConnectResponse();

218

<a name="209" href="#209">209</a> response.setConnectMethod(method);

219

220

<a name="211" href="#211">211</a> // only set the socket if the connect was successful

221

<a name="212" href="#212">212</a> if (method.getStatusCode() == HttpStatus.SC_OK) {

222

<a name="213" href="#213">213</a> response.setSocket(connectionManager.getConnection().getSocket());

223

<a name="214" href="#214">214</a> } else {

224

<a name="215" href="#215">215</a> connectionManager.getConnection().close();

225

<a name="216" href="#216">216</a> }

226

227

<a name="218" href="#218">218</a> return response;

228

<a name="219" href="#219">219</a> }

229

230

<a name="221" href="#221">221</a> /**

231

<a name="222" href="#222">222</a> * Contains the method used to execute the connect along with the created socket.

232

<a name="223" href="#223">223</a> */

233

<a name="224" href="#224">224</a> public static class ConnectResponse {

234

235

<a name="226" href="#226">226</a> private <a href="../../../../org/apache/commons/httpclient/ConnectMethod.html">ConnectMethod</a> connectMethod;

236

237

<a name="228" href="#228">228</a> private Socket socket;

238

239

<a name="230" href="#230">230</a> private ConnectResponse() {}

240

241

<a name="232" href="#232">232</a> /**

242

<a name="233" href="#233">233</a> * Gets the method that was used to execute the connect. This method is useful for

243

<a name="234" href="#234">234</a> * analyzing the proxy's response when a connect fails.

244

<a name="235" href="#235">235</a> *

245

<a name="236" href="#236">236</a> * @return the connectMethod.

246

<a name="237" href="#237">237</a> */

247

<a name="238" href="#238">238</a> public <a href="../../../../org/apache/commons/httpclient/ConnectMethod.html">ConnectMethod</a> getConnectMethod() {

248

<a name="239" href="#239">239</a> return connectMethod;

249

<a name="240" href="#240">240</a> }

250

<a name="241" href="#241">241</a> /**

251

<a name="242" href="#242">242</a> * @param connectMethod The connectMethod to set.

252

<a name="243" href="#243">243</a> */

253

<a name="244" href="#244">244</a> private void setConnectMethod(<a href="../../../../org/apache/commons/httpclient/ConnectMethod.html">ConnectMethod</a> connectMethod) {

254

<a name="245" href="#245">245</a> this.connectMethod = connectMethod;

255

<a name="246" href="#246">246</a> }

256

<a name="247" href="#247">247</a> /**

257

<a name="248" href="#248">248</a> * Gets the socket connected and authenticated (if appropriate) to the configured

258

<a name="249" href="#249">249</a> * HTTP proxy, or <code>null</code> if a connection could not be made. It is the

259

<a name="250" href="#250">250</a> * responsibility of the user to close this socket when it is no longer needed.

260

<a name="251" href="#251">251</a> *

261

<a name="252" href="#252">252</a> * @return the socket.

262

<a name="253" href="#253">253</a> */

263

<a name="254" href="#254">254</a> public Socket getSocket() {

264

<a name="255" href="#255">255</a> return socket;

265

<a name="256" href="#256">256</a> }

266

<a name="257" href="#257">257</a> /**

267

<a name="258" href="#258">258</a> * @param socket The socket to set.

268

<a name="259" href="#259">259</a> */

269

<a name="260" href="#260">260</a> private void setSocket(Socket socket) {

270

<a name="261" href="#261">261</a> this.socket = socket;

271

<a name="262" href="#262">262</a> }

272

<a name="263" href="#263">263</a> }

273

274

<a name="265" href="#265">265</a> /**

275

<a name="266" href="#266">266</a> * A connection manager that creates a single connection. Meant to be used only once.

276

<a name="267" href="#267">267</a> */

277

<a name="268" href="#268">268</a> static class DummyConnectionManager implements <a href="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> {

278

279

<a name="270" href="#270">270</a> private <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> httpConnection;

280

281

<a name="272" href="#272">272</a> private <a href="../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> connectionParams;

282

283

<a name="274" href="#274">274</a> public void closeIdleConnections(long idleTimeout) {

284

<a name="275" href="#275">275</a> }

285

286

<a name="277" href="#277">277</a> public <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> getConnection() {

287

<a name="278" href="#278">278</a> return httpConnection;

288

<a name="279" href="#279">279</a> }

289

290

<a name="281" href="#281">281</a> public void setConnectionParams(<a href="../../../../org/apache/commons/httpclient/params/HttpParams.html">HttpParams</a> httpParams) {

291

<a name="282" href="#282">282</a> this.connectionParams = httpParams;

292

<a name="283" href="#283">283</a> }

293

294

<a name="285" href="#285">285</a> public <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> getConnectionWithTimeout(

295

<a name="286" href="#286">286</a> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration, long timeout) {

296

297

<a name="288" href="#288">288</a> httpConnection = new <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(hostConfiguration);

298

<a name="289" href="#289">289</a> httpConnection.setHttpConnectionManager(this);

299

<a name="290" href="#290">290</a> httpConnection.getParams().setDefaults(connectionParams);

300

<a name="291" href="#291">291</a> return httpConnection;

301

<a name="292" href="#292">292</a> }

302

303

<a name="294" href="#294">294</a> /**

304

<a name="295" href="#295">295</a> * @deprecated

305

<a name="296" href="#296">296</a> */

306

<a name="297" href="#297">297</a> public <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> getConnection(<a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration, long timeout)

307

<a name="298" href="#298">298</a> throws <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {

308

<a name="299" href="#299">299</a> return getConnectionWithTimeout(hostConfiguration, timeout);

309

<a name="300" href="#300">300</a> }

310

311

<a name="302" href="#302">302</a> public <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> getConnection(<a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration) {

312

<a name="303" href="#303">303</a> return getConnectionWithTimeout(hostConfiguration, -1);

313

<a name="304" href="#304">304</a> }

314

315

<a name="306" href="#306">306</a> public void releaseConnection(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

316

<a name="307" href="#307">307</a> }

317

318

<a name="309" href="#309">309</a> public <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionManagerParams.html">HttpConnectionManagerParams</a> getParams() {

319

<a name="310" href="#310">310</a> return null;

320

<a name="311" href="#311">311</a> }

321

322

<a name="313" href="#313">313</a> public void setParams(<a href="../../../../org/apache/commons/httpclient/params/HttpConnectionManagerParams.html">HttpConnectionManagerParams</a> params) {

323

<a name="314" href="#314">314</a> }

324

<a name="315" href="#315">315</a> }

325

<a name="316" href="#316">316</a> }

326

</pre>

327

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

328

</html>

329

Older »