~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/SimpleHttpConnectionManager.java,v 1.23 2004/10/16 22:40:08 mbecke 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.io.InputStream;

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

<a name="37" href="#37">37</a> import org.apache.commons.logging.Log;

<a name="38" href="#38">38</a> import org.apache.commons.logging.LogFactory;

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

<a name="41" href="#41">41</a> * A connection manager that provides access to a single HttpConnection. This

<a name="42" href="#42">42</a> * manager makes no attempt to provide exclusive access to the contained

<a name="43" href="#43">43</a> * HttpConnection.

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

<a name="45" href="#45">45</a> * @author <a href="<a href="mailto:becke@u.washington.edu" target="alexandria_uri">mailto:becke@u.washington.edu</a>">Michael Becke</a>

<a name="46" href="#46">46</a> * @author Eric Johnson

<a name="47" href="#47">47</a> * @author <a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler</a>

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

<a name="49" href="#49">49</a> * @author Laura Werner

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

<a name="51" href="#51">51</a> * @since 2.0

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

<a name="53" href="#53">53</a> public class <a href="../../../../org/apache/commons/httpclient/SimpleHttpConnectionManager.html">SimpleHttpConnectionManager</a> implements <a href="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> {

<a name="55" href="#55">55</a> private static final Log LOG = LogFactory.getLog(SimpleHttpConnectionManager.class);

<a name="57" href="#57">57</a> private static final String MISUSE_MESSAGE =

<a name="58" href="#58">58</a> "SimpleHttpConnectionManager being used incorrectly. Be sure that"

<a name="59" href="#59">59</a> + " HttpMethod.releaseConnection() is always called and that only one thread"

<a name="60" href="#60">60</a> + " and/or method is using this connection manager at a time.";

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

<a name="63" href="#63">63</a> * Since the same connection is about to be reused, make sure the

<a name="64" href="#64">64</a> * previous request was completely processed, and if not

<a name="65" href="#65">65</a> * consume it now.

<a name="66" href="#66">66</a> * @param conn The connection

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

<a name="68" href="#68">68</a> static void finishLastResponse(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

<a name="69" href="#69">69</a> InputStream lastResponse = conn.getLastResponseInputStream();

<a name="70" href="#70">70</a> if (lastResponse != null) {

<a name="71" href="#71">71</a> conn.setLastResponseInputStream(null);

<a name="72" href="#72">72</a> try {

<a name="73" href="#73">73</a> lastResponse.close();

<a name="74" href="#74">74</a> } catch (IOException ioe) {

<a name="75" href="#75">75</a> conn.close();

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

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

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

<a name="80" href="#80">80</a> /** The http connection */

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

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

<a name="84" href="#84">84</a> * Collection of parameters associated with this connection manager.

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

<a name="86" href="#86">86</a> private <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionManagerParams.html">HttpConnectionManagerParams</a> params = new <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionManagerParams.html">HttpConnectionManagerParams</a>();

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

<a name="89" href="#89">89</a> * The time the connection was made idle.

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

100

<a name="91" href="#91">91</a> private long idleStartTime = Long.MAX_VALUE;

101

102

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

103

<a name="94" href="#94">94</a> * Used to test if {@link #httpConnection} is currently in use

104

<a name="95" href="#95">95</a> * (i.e. checked out). This is only used as a sanity check to help

105

<a name="96" href="#96">96</a> * debug cases where this connection manager is being used incorrectly.

106

<a name="97" href="#97">97</a> * It will not be used to enforce thread safety.

107

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

108

<a name="99" href="#99">99</a> private volatile boolean inUse = false;

109

110

<a name="101" href="#101">101</a> private boolean alwaysClose = false;

111

112

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

113

<a name="104" href="#104">104</a> * The connection manager created with this constructor will try to keep the

114

<a name="105" href="#105">105</a> * connection open (alive) between consecutive requests if the alwaysClose

115

<a name="106" href="#106">106</a> * parameter is set to <tt>false</tt>. Otherwise the connection manager will

116

<a name="107" href="#107">107</a> * always close connections upon release.

117

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

118

<a name="109" href="#109">109</a> * @param alwaysClose if set <tt>true</tt>, the connection manager will always

119

<a name="110" href="#110">110</a> * close connections upon release.

120

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

121

<a name="112" href="#112">112</a> public <a href="../../../../org/apache/commons/httpclient/SimpleHttpConnectionManager.html">SimpleHttpConnectionManager</a>(boolean alwaysClose) {

122

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

123

<a name="114" href="#114">114</a> this.alwaysClose = alwaysClose;

124

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

125

126

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

127

<a name="118" href="#118">118</a> * The connection manager created with this constructor will always try to keep

128

<a name="119" href="#119">119</a> * the connection open (alive) between consecutive requests.

129

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

130

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

131

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

132

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

133

134

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

135

<a name="126" href="#126">126</a> * @see HttpConnectionManager#getConnection(HostConfiguration)

136

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

137

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

138

<a name="129" href="#129">129</a> return getConnection(hostConfiguration, 0);

139

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

140

141

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

142

<a name="133" href="#133">133</a> * Gets the staleCheckingEnabled value to be set on HttpConnections that are created.

143

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

144

<a name="135" href="#135">135</a> * @return <code>true</code> if stale checking will be enabled on HttpConections

145

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

146

<a name="137" href="#137">137</a> * @see HttpConnection#isStaleCheckingEnabled()

147

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

148

<a name="139" href="#139">139</a> * @deprecated Use {@link HttpConnectionManagerParams#isStaleCheckingEnabled()},

149

<a name="140" href="#140">140</a> * {@link HttpConnectionManager#getParams()}.

150

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

151

<a name="142" href="#142">142</a> public boolean isConnectionStaleCheckingEnabled() {

152

<a name="143" href="#143">143</a> return this.params.isStaleCheckingEnabled();

153

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

154

155

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

156

<a name="147" href="#147">147</a> * Sets the staleCheckingEnabled value to be set on HttpConnections that are created.

157

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

158

<a name="149" href="#149">149</a> * @param connectionStaleCheckingEnabled <code>true</code> if stale checking will be enabled

159

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

160

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

161

<a name="152" href="#152">152</a> * @see HttpConnection#setStaleCheckingEnabled(boolean)

162

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

163

<a name="154" href="#154">154</a> * @deprecated Use {@link HttpConnectionManagerParams#setStaleCheckingEnabled(boolean)},

164

<a name="155" href="#155">155</a> * {@link HttpConnectionManager#getParams()}.

165

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

166

<a name="157" href="#157">157</a> public void setConnectionStaleCheckingEnabled(boolean connectionStaleCheckingEnabled) {

167

<a name="158" href="#158">158</a> this.params.setStaleCheckingEnabled(connectionStaleCheckingEnabled);

168

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

169

170

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

171

<a name="162" href="#162">162</a> * This method always returns the same connection object. If the connection is already

172

<a name="163" href="#163">163</a> * open, it will be closed and the new host configuration will be applied.

173

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

174

<a name="165" href="#165">165</a> * @param hostConfiguration The host configuration specifying the connection

175

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

176

<a name="167" href="#167">167</a> * @param timeout this parameter has no effect. The connection is always returned

177

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

178

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

179

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

180

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

181

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

182

183

<a name="174" href="#174">174</a> if (httpConnection == null) {

184

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

185

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

186

<a name="177" href="#177">177</a> httpConnection.getParams().setDefaults(this.params);

187

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

188

189

<a name="180" href="#180">180</a> // make sure the host and proxy are correct for this connection

190

<a name="181" href="#181">181</a> // close it and set the values if they are not

191

<a name="182" href="#182">182</a> if (!hostConfiguration.hostEquals(httpConnection)

192

<a name="183" href="#183">183</a> || !hostConfiguration.proxyEquals(httpConnection)) {

193

194

<a name="185" href="#185">185</a> if (httpConnection.isOpen()) {

195

<a name="186" href="#186">186</a> httpConnection.close();

196

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

197

198

<a name="189" href="#189">189</a> httpConnection.setHost(hostConfiguration.getHost());

199

<a name="190" href="#190">190</a> httpConnection.setPort(hostConfiguration.getPort());

200

<a name="191" href="#191">191</a> httpConnection.setProtocol(hostConfiguration.getProtocol());

201

<a name="192" href="#192">192</a> httpConnection.setLocalAddress(hostConfiguration.getLocalAddress());

202

203

<a name="194" href="#194">194</a> httpConnection.setProxyHost(hostConfiguration.getProxyHost());

204

<a name="195" href="#195">195</a> httpConnection.setProxyPort(hostConfiguration.getProxyPort());

205

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

206

<a name="197" href="#197">197</a> finishLastResponse(httpConnection);

207

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

208

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

209

210

<a name="201" href="#201">201</a> // remove the connection from the timeout handler

211

<a name="202" href="#202">202</a> idleStartTime = Long.MAX_VALUE;

212

213

<a name="204" href="#204">204</a> if (inUse) LOG.warn(MISUSE_MESSAGE);

214

<a name="205" href="#205">205</a> inUse = true;

215

216

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

217

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

218

219

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

220

<a name="211" href="#211">211</a> * @see HttpConnectionManager#getConnection(HostConfiguration, long)

221

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

222

<a name="213" href="#213">213</a> * @deprecated Use #getConnectionWithTimeout(HostConfiguration, long)

223

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

224

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

225

<a name="216" href="#216">216</a> HostConfiguration hostConfiguration, long timeout) {

226

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

227

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

228

229

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

230

<a name="221" href="#221">221</a> * @see HttpConnectionManager#releaseConnection(org.apache.commons.httpclient.HttpConnection)

231

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

232

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

233

<a name="224" href="#224">224</a> if (conn != httpConnection) {

234

<a name="225" href="#225">225</a> throw new IllegalStateException("Unexpected release of an unknown connection.");

235

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

236

<a name="227" href="#227">227</a> if (this.alwaysClose) {

237

<a name="228" href="#228">228</a> httpConnection.close();

238

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

239

<a name="230" href="#230">230</a> // make sure the connection is reuseable

240

<a name="231" href="#231">231</a> finishLastResponse(httpConnection);

241

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

242

243

<a name="234" href="#234">234</a> inUse = false;

244

245

<a name="236" href="#236">236</a> // track the time the connection was made idle

246

<a name="237" href="#237">237</a> idleStartTime = System.currentTimeMillis();

247

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

248

249

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

250

<a name="241" href="#241">241</a> * Returns {@link HttpConnectionManagerParams parameters} associated

251

<a name="242" href="#242">242</a> * with this connection manager.

252

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

253

<a name="244" href="#244">244</a> * @since 2.1

254

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

255

<a name="246" href="#246">246</a> * @see HttpConnectionManagerParams

256

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

257

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

258

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

259

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

260

261

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

262

<a name="253" href="#253">253</a> * Assigns {@link HttpConnectionManagerParams parameters} for this

263

<a name="254" href="#254">254</a> * connection manager.

264

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

265

<a name="256" href="#256">256</a> * @since 2.1

266

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

267

<a name="258" href="#258">258</a> * @see HttpConnectionManagerParams

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

276

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

277

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

278

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

279

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

280

<a name="271" href="#271">271</a> long maxIdleTime = System.currentTimeMillis() - idleTimeout;

281

<a name="272" href="#272">272</a> if (idleStartTime <= maxIdleTime) {

282

<a name="273" href="#273">273</a> httpConnection.close();

283

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

284

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

285

286

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

287

<a name="278" href="#278">278</a> * since 3.1

288

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

289

<a name="280" href="#280">280</a> public void shutdown() {

290

<a name="281" href="#281">281</a> httpConnection.close();

291

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

292

293

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

294

</pre>

295

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

296

</html>

297

Older »