~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/HttpState.java,v 1.38 2004/12/20 11:50:54 olegk Exp $

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

<a name="4" href="#4">4</a> * $Date: 2007-07-30 21:41:17 +0200 (Mon, 30 Jul 2007) $

<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.util.ArrayList;

<a name="34" href="#34">34</a> import java.util.Date;

<a name="35" href="#35">35</a> import java.util.HashMap;

<a name="36" href="#36">36</a> import java.util.Map;

<a name="37" href="#37">37</a> import java.util.List;

<a name="38" href="#38">38</a> import java.util.Iterator;

<a name="39" href="#39">39</a> import org.apache.commons.httpclient.cookie.CookieSpec;

<a name="40" href="#40">40</a> import org.apache.commons.httpclient.cookie.CookiePolicy;

<a name="41" href="#41">41</a> import org.apache.commons.httpclient.auth.AuthScope;

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

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

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

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

<a name="47" href="#47">47</a> * A container for HTTP attributes that may persist from request

<a name="48" href="#48">48</a> * to request, such as {@link Cookie cookies} and authentication

<a name="49" href="#49">49</a> * {@link Credentials credentials}.

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

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

<a name="52" href="#52">52</a> * @author <a href="<a href="mailto:remm@apache.org" target="alexandria_uri">mailto:remm@apache.org</a>">Remy Maucherat</a>

<a name="53" href="#53">53</a> * @author Rodney Waldhoff

<a name="54" href="#54">54</a> * @author <a href="<a href="mailto:jsdever@apache.org" target="alexandria_uri">mailto:jsdever@apache.org</a>">Jeff Dever</a>

<a name="55" href="#55">55</a> * @author Sean C. Sullivan

<a name="56" href="#56">56</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="57" href="#57">57</a> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a>

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

<a name="59" href="#59">59</a> * @author <a href="<a href="mailto:adrian@intencha.com" target="alexandria_uri">mailto:adrian@intencha.com</a>">Adrian Sutton</a>

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

<a name="61" href="#61">61</a> * @version $Revision: 561099 $ $Date: 2007-07-30 21:41:17 +0200 (Mon, 30 Jul 2007) $

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

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

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

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

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

<a name="69" href="#69">69</a> * Map of {@link Credentials credentials} by realm that this

<a name="70" href="#70">70</a> * HTTP state contains.

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

<a name="72" href="#72">72</a> protected HashMap credMap = new HashMap();

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

<a name="75" href="#75">75</a> * Map of {@link Credentials proxy credentials} by realm that this

<a name="76" href="#76">76</a> * HTTP state contains

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

<a name="78" href="#78">78</a> protected HashMap proxyCred = new HashMap();

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

<a name="81" href="#81">81</a> * Array of {@link Cookie cookies} that this HTTP state contains.

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

<a name="83" href="#83">83</a> protected ArrayList cookies = new ArrayList();

<a name="85" href="#85">85</a> private boolean preemptive = false;

<a name="87" href="#87">87</a> private int cookiePolicy = -1;

<a name="88" href="#88">88</a> // -------------------------------------------------------- Class Variables

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

100

<a name="91" href="#91">91</a> * The boolean system property name to turn on preemptive authentication.

101

<a name="92" href="#92">92</a> * @deprecated This field and feature will be removed following HttpClient 3.0.

102

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

103

<a name="94" href="#94">94</a> public static final String PREEMPTIVE_PROPERTY = "httpclient.authentication.preemptive";

104

105

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

106

<a name="97" href="#97">97</a> * The default value for {@link #PREEMPTIVE_PROPERTY}.

107

<a name="98" href="#98">98</a> * @deprecated This field and feature will be removed following HttpClient 3.0.

108

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

109

<a name="100" href="#100">100</a> public static final String PREEMPTIVE_DEFAULT = "false";

110

111

<a name="102" href="#102">102</a> /** Log object for this class. */

112

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

113

114

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

115

<a name="106" href="#106">106</a> * Default constructor.

116

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

117

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

118

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

119

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

120

121

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

122

123

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

124

<a name="115" href="#115">115</a> * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies.

125

<a name="116" href="#116">116</a> * If the given cookie has already expired it will not be added, but existing

126

<a name="117" href="#117">117</a> * values will still be removed.

127

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

128

<a name="119" href="#119">119</a> * @param cookie the {@link Cookie cookie} to be added

129

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

130

<a name="121" href="#121">121</a> * @see #addCookies(Cookie[])

131

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

132

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

133

<a name="124" href="#124">124</a> public synchronized void addCookie(<a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) {

134

<a name="125" href="#125">125</a> LOG.trace("enter HttpState.addCookie(Cookie)");

135

136

<a name="127" href="#127">127</a> if (cookie != null) {

137

<a name="128" href="#128">128</a> // first remove any old cookie that is equivalent

138

<a name="129" href="#129">129</a> for (Iterator it = cookies.iterator(); it.hasNext();) {

139

<a name="130" href="#130">130</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> tmp = (Cookie) it.next();

140

<a name="131" href="#131">131</a> if (cookie.equals(tmp)) {

141

<a name="132" href="#132">132</a> it.remove();

142

<a name="133" href="#133">133</a> break;

143

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

144

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

145

<a name="136" href="#136">136</a> if (!cookie.isExpired()) {

146

<a name="137" href="#137">137</a> cookies.add(cookie);

147

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

148

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

149

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

150

151

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

152

<a name="143" href="#143">143</a> * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and

153

<a name="144" href="#144">144</a> * in the given array order. If any of the given cookies has already expired it will

154

<a name="145" href="#145">145</a> * not be added, but existing values will still be removed.

155

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

156

<a name="147" href="#147">147</a> * @param cookies the {@link Cookie cookies} to be added

157

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

158

<a name="149" href="#149">149</a> * @see #addCookie(Cookie)

159

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

160

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

161

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

162

<a name="153" href="#153">153</a> public synchronized void addCookies(<a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies) {

163

<a name="154" href="#154">154</a> LOG.trace("enter HttpState.addCookies(Cookie[])");

164

165

<a name="156" href="#156">156</a> if (cookies != null) {

166

<a name="157" href="#157">157</a> for (int i = 0; i < cookies.length; i++) {

167

<a name="158" href="#158">158</a> this.addCookie(cookies[i]);

168

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

169

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

170

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

171

172

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

173

<a name="164" href="#164">164</a> * Returns an array of {@link Cookie cookies} that this HTTP

174

<a name="165" href="#165">165</a> * state currently contains.

175

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

176

<a name="167" href="#167">167</a> * @return an array of {@link Cookie cookies}.

177

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

178

<a name="169" href="#169">169</a> * @see #getCookies(String, int, String, boolean)

179

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

180

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

181

<a name="172" href="#172">172</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] getCookies() {

182

<a name="173" href="#173">173</a> LOG.trace("enter HttpState.getCookies()");

183

<a name="174" href="#174">174</a> return (Cookie[]) (cookies.toArray(new Cookie[cookies.size()]));

184

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

185

186

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

187

<a name="178" href="#178">178</a> * Returns an array of {@link Cookie cookies} in this HTTP

188

<a name="179" href="#179">179</a> * state that match the given request parameters.

189

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

190

<a name="181" href="#181">181</a> * @param domain the request domain

191

<a name="182" href="#182">182</a> * @param port the request port

192

<a name="183" href="#183">183</a> * @param path the request path

193

<a name="184" href="#184">184</a> * @param secure <code>true</code> when using HTTPS

194

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

195

<a name="186" href="#186">186</a> * @return an array of {@link Cookie cookies}.

196

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

197

<a name="188" href="#188">188</a> * @see #getCookies()

198

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

199

<a name="190" href="#190">190</a> * @deprecated use CookieSpec#match(String, int, String, boolean, Cookie)

200

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

201

<a name="192" href="#192">192</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] getCookies(

202

<a name="193" href="#193">193</a> String domain,

203

<a name="194" href="#194">194</a> int port,

204

<a name="195" href="#195">195</a> String path,

205

<a name="196" href="#196">196</a> boolean secure

206

<a name="197" href="#197">197</a> ) {

207

<a name="198" href="#198">198</a> LOG.trace("enter HttpState.getCookies(String, int, String, boolean)");

208

209

<a name="200" href="#200">200</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> matcher = CookiePolicy.getDefaultSpec();

210

<a name="201" href="#201">201</a> ArrayList list = new ArrayList(cookies.size());

211

<a name="202" href="#202">202</a> for (int i = 0, m = cookies.size(); i < m; i++) {

212

<a name="203" href="#203">203</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie = (Cookie) (cookies.get(i));

213

<a name="204" href="#204">204</a> if (matcher.match(domain, port, path, secure, cookie)) {

214

<a name="205" href="#205">205</a> list.add(cookie);

215

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

216

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

217

<a name="208" href="#208">208</a> return (Cookie[]) (list.toArray(new Cookie[list.size()]));

218

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

219

220

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

221

<a name="212" href="#212">212</a> * Removes all of {@link Cookie cookies} in this HTTP state

222

<a name="213" href="#213">213</a> * that have expired according to the current system time.

223

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

224

<a name="215" href="#215">215</a> * @see #purgeExpiredCookies(java.util.Date)

225

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

226

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

227

<a name="218" href="#218">218</a> public synchronized boolean purgeExpiredCookies() {

228

<a name="219" href="#219">219</a> LOG.trace("enter HttpState.purgeExpiredCookies()");

229

<a name="220" href="#220">220</a> return purgeExpiredCookies(new Date());

230

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

231

232

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

233

<a name="224" href="#224">224</a> * Removes all of {@link Cookie cookies} in this HTTP state

234

<a name="225" href="#225">225</a> * that have expired by the specified {@link java.util.Date date}.

235

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

236

<a name="227" href="#227">227</a> * @param date The {@link java.util.Date date} to compare against.

237

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

238

<a name="229" href="#229">229</a> * @return true if any cookies were purged.

239

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

240

<a name="231" href="#231">231</a> * @see Cookie#isExpired(java.util.Date)

241

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

242

<a name="233" href="#233">233</a> * @see #purgeExpiredCookies()

243

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

244

<a name="235" href="#235">235</a> public synchronized boolean purgeExpiredCookies(Date date) {

245

<a name="236" href="#236">236</a> LOG.trace("enter HttpState.purgeExpiredCookies(Date)");

246

<a name="237" href="#237">237</a> boolean removed = false;

247

<a name="238" href="#238">238</a> Iterator it = cookies.iterator();

248

<a name="239" href="#239">239</a> while (it.hasNext()) {

249

<a name="240" href="#240">240</a> if (((Cookie) (it.next())).isExpired(date)) {

250

<a name="241" href="#241">241</a> it.remove();

251

<a name="242" href="#242">242</a> removed = true;

252

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

253

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

254

<a name="245" href="#245">245</a> return removed;

255

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

256

257

258

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

259

<a name="250" href="#250">250</a> * Returns the current {@link CookiePolicy cookie policy} for this

260

<a name="251" href="#251">251</a> * HTTP state.

261

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

262

<a name="253" href="#253">253</a> * @return The {@link CookiePolicy cookie policy}.

263

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

264

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

265

<a name="256" href="#256">256</a> * {@link org.apache.commons.httpclient.params.HttpMethodParams#getCookiePolicy()},

266

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

267

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

268

269

<a name="260" href="#260">260</a> public int getCookiePolicy() {

270

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

271

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

272

273

274

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

275

<a name="266" href="#266">266</a> * Defines whether preemptive authentication should be

276

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

277

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

278

<a name="269" href="#269">269</a> * @param value <tt>true</tt> if preemptive authentication should be

279

<a name="270" href="#270">270</a> * attempted, <tt>false</tt> otherwise.

280

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

281

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

282

<a name="273" href="#273">273</a> * {@link org.apache.commons.httpclient.params.HttpClientParams#setAuthenticationPreemptive(boolean)},

283

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

284

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

285

286

<a name="277" href="#277">277</a> public void setAuthenticationPreemptive(boolean value) {

287

<a name="278" href="#278">278</a> this.preemptive = value;

288

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

289

290

291

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

292

<a name="283" href="#283">283</a> * Returns <tt>true</tt> if preemptive authentication should be

293

<a name="284" href="#284">284</a> * attempted, <tt>false</tt> otherwise.

294

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

295

<a name="286" href="#286">286</a> * @return boolean flag.

296

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

297

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

298

<a name="289" href="#289">289</a> * {@link org.apache.commons.httpclient.params.HttpClientParams#isAuthenticationPreemptive()},

299

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

300

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

301

302

<a name="293" href="#293">293</a> public boolean isAuthenticationPreemptive() {

303

<a name="294" href="#294">294</a> return this.preemptive;

304

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

305

306

307

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

308

<a name="299" href="#299">299</a> * Sets the current {@link CookiePolicy cookie policy} for this HTTP

309

<a name="300" href="#300">300</a> * state to one of the following supported policies:

310

<a name="301" href="#301">301</a> * {@link CookiePolicy#COMPATIBILITY},

311

<a name="302" href="#302">302</a> * {@link CookiePolicy#NETSCAPE_DRAFT} or

312

<a name="303" href="#303">303</a> * {@link CookiePolicy#RFC2109}.

313

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

314

<a name="305" href="#305">305</a> * @param policy new {@link CookiePolicy cookie policy}

315

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

316

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

317

<a name="308" href="#308">308</a> * Use {@link org.apache.commons.httpclient.params.HttpMethodParams#setCookiePolicy(String)},

318

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

319

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

320

321

<a name="312" href="#312">312</a> public void setCookiePolicy(int policy) {

322

<a name="313" href="#313">313</a> this.cookiePolicy = policy;

323

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

324

325

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

326

<a name="317" href="#317">317</a> * Sets the {@link Credentials credentials} for the given authentication

327

<a name="318" href="#318">318</a> * realm on the given host. The <code>null</code> realm signifies default

328

<a name="319" href="#319">319</a> * credentials for the given host, which should be used when no

329

<a name="320" href="#320">320</a> * {@link Credentials credentials} have been explictly supplied for the

330

<a name="321" href="#321">321</a> * challenging realm. The <code>null</code> host signifies default

331

<a name="322" href="#322">322</a> * credentials, which should be used when no {@link Credentials credentials}

332

<a name="323" href="#323">323</a> * have been explictly supplied for the challenging host. Any previous

333

<a name="324" href="#324">324</a> * credentials for the given realm on the given host will be overwritten.

334

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

335

<a name="326" href="#326">326</a> * @param realm the authentication realm

336

<a name="327" href="#327">327</a> * @param host the host the realm belongs to

337

<a name="328" href="#328">328</a> * @param credentials the authentication {@link Credentials credentials}

338

<a name="329" href="#329">329</a> * for the given realm.

339

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

340

<a name="331" href="#331">331</a> * @see #getCredentials(String, String)

341

<a name="332" href="#332">332</a> * @see #setProxyCredentials(String, String, Credentials)

342

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

343

<a name="334" href="#334">334</a> * @deprecated use #setCredentials(AuthScope, Credentials)

344

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

345

346

<a name="337" href="#337">337</a> public synchronized void setCredentials(String realm, String host, <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> credentials) {

347

<a name="338" href="#338">338</a> LOG.trace("enter HttpState.setCredentials(String, String, Credentials)");

348

<a name="339" href="#339">339</a> credMap.put(new <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(host, AuthScope.ANY_PORT, realm, AuthScope.ANY_SCHEME), credentials);

349

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

350

351

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

352

<a name="343" href="#343">343</a> * Sets the {@link Credentials credentials} for the given authentication

353

<a name="344" href="#344">344</a> * scope. Any previous credentials for the given scope will be overwritten.

354

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

355

<a name="346" href="#346">346</a> * @param authscope the {@link AuthScope authentication scope}

356

<a name="347" href="#347">347</a> * @param credentials the authentication {@link Credentials credentials}

357

<a name="348" href="#348">348</a> * for the given scope.

358

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

359

<a name="350" href="#350">350</a> * @see #getCredentials(AuthScope)

360

<a name="351" href="#351">351</a> * @see #setProxyCredentials(AuthScope, Credentials)

361

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

362

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

363

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

364

<a name="355" href="#355">355</a> public synchronized void setCredentials(final <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope, final <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> credentials) {

365

<a name="356" href="#356">356</a> if (authscope == null) {

366

<a name="357" href="#357">357</a> throw new IllegalArgumentException("Authentication scope may not be null");

367

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

368

<a name="359" href="#359">359</a> LOG.trace("enter HttpState.setCredentials(AuthScope, Credentials)");

369

<a name="360" href="#360">360</a> credMap.put(authscope, credentials);

370

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

371

372

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

373

<a name="364" href="#364">364</a> * Find matching {@link Credentials credentials} for the given authentication scope.

374

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

375

<a name="366" href="#366">366</a> * @param map the credentials hash map

376

<a name="367" href="#367">367</a> * @param token the {@link AuthScope authentication scope}

377

<a name="368" href="#368">368</a> * @return the credentials

378

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

379

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

380

<a name="371" href="#371">371</a> private static <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> matchCredentials(final HashMap map, final <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope) {

381

<a name="372" href="#372">372</a> // see if we get a direct hit

382

<a name="373" href="#373">373</a> <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> creds = (Credentials)map.get(authscope);

383

<a name="374" href="#374">374</a> if (creds == null) {

384

<a name="375" href="#375">375</a> // Nope.

385

<a name="376" href="#376">376</a> // Do a full scan

386

<a name="377" href="#377">377</a> int bestMatchFactor = -1;

387

<a name="378" href="#378">378</a> <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> bestMatch = null;

388

<a name="379" href="#379">379</a> Iterator items = map.keySet().iterator();

389

<a name="380" href="#380">380</a> while (items.hasNext()) {

390

<a name="381" href="#381">381</a> <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> current = (AuthScope)items.next();

391

<a name="382" href="#382">382</a> int factor = authscope.match(current);

392

<a name="383" href="#383">383</a> if (factor > bestMatchFactor) {

393

<a name="384" href="#384">384</a> bestMatchFactor = factor;

394

<a name="385" href="#385">385</a> bestMatch = current;

395

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

396

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

397

<a name="388" href="#388">388</a> if (bestMatch != null) {

398

<a name="389" href="#389">389</a> creds = (Credentials)map.get(bestMatch);

399

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

400

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

401

<a name="392" href="#392">392</a> return creds;

402

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

403

404

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

405

<a name="396" href="#396">396</a> * Get the {@link Credentials credentials} for the given authentication scope on the

406

<a name="397" href="#397">397</a> * given host.

407

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

408

<a name="399" href="#399">399</a> * If the realm exists on host, return the coresponding credentials.

409

<a name="400" href="#400">400</a> * If the host exists with a <tt>null</tt> realm, return the corresponding

410

<a name="401" href="#401">401</a> * credentials.

411

<a name="402" href="#402">402</a> * If the realm exists with a <tt>null</tt> host, return the

412

<a name="403" href="#403">403</a> * corresponding credentials. If the realm does not exist, return

413

<a name="404" href="#404">404</a> * the default Credentials. If there are no default credentials, return

414

<a name="405" href="#405">405</a> * <code>null</code>.

415

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

416

<a name="407" href="#407">407</a> * @param realm the authentication realm

417

<a name="408" href="#408">408</a> * @param host the host the realm is on

418

<a name="409" href="#409">409</a> * @return the credentials

419

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

420

<a name="411" href="#411">411</a> * @see #setCredentials(String, String, Credentials)

421

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

422

<a name="413" href="#413">413</a> * @deprecated use #getCredentials(AuthScope)

423

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

424

425

<a name="416" href="#416">416</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> getCredentials(String realm, String host) {

426

<a name="417" href="#417">417</a> LOG.trace("enter HttpState.getCredentials(String, String");

427

<a name="418" href="#418">418</a> return matchCredentials(this.credMap,

428

<a name="419" href="#419">419</a> new <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(host, AuthScope.ANY_PORT, realm, AuthScope.ANY_SCHEME));

429

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

430

431

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

432

<a name="423" href="#423">423</a> * Get the {@link Credentials credentials} for the given authentication scope.

433

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

434

<a name="425" href="#425">425</a> * @param authscope the {@link AuthScope authentication scope}

435

<a name="426" href="#426">426</a> * @return the credentials

436

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

437

<a name="428" href="#428">428</a> * @see #setCredentials(AuthScope, Credentials)

438

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

439

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

440

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

441

<a name="432" href="#432">432</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> getCredentials(final <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope) {

442

<a name="433" href="#433">433</a> if (authscope == null) {

443

<a name="434" href="#434">434</a> throw new IllegalArgumentException("Authentication scope may not be null");

444

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

445

<a name="436" href="#436">436</a> LOG.trace("enter HttpState.getCredentials(AuthScope)");

446

<a name="437" href="#437">437</a> return matchCredentials(this.credMap, authscope);

447

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

448

449

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

450

<a name="441" href="#441">441</a> * Sets the {@link Credentials credentials} for the given proxy authentication

451

<a name="442" href="#442">442</a> * realm on the given proxy host. The <code>null</code> proxy realm signifies

452

<a name="443" href="#443">443</a> * default credentials for the given proxy host, which should be used when no

453

<a name="444" href="#444">444</a> * {@link Credentials credentials} have been explictly supplied for the

454

<a name="445" href="#445">445</a> * challenging proxy realm. The <code>null</code> proxy host signifies default

455

<a name="446" href="#446">446</a> * credentials, which should be used when no {@link Credentials credentials}

456

<a name="447" href="#447">447</a> * have been explictly supplied for the challenging proxy host. Any previous

457

<a name="448" href="#448">448</a> * credentials for the given proxy realm on the given proxy host will be

458

<a name="449" href="#449">449</a> * overwritten.

459

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

460

<a name="451" href="#451">451</a> * @param realm the authentication realm

461

<a name="452" href="#452">452</a> * @param proxyHost the proxy host

462

<a name="453" href="#453">453</a> * @param credentials the authentication credentials for the given realm

463

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

464

<a name="455" href="#455">455</a> * @see #getProxyCredentials(AuthScope)

465

<a name="456" href="#456">456</a> * @see #setCredentials(AuthScope, Credentials)

466

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

467

<a name="458" href="#458">458</a> * @deprecated use #setProxyCredentials(AuthScope, Credentials)

468

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

469

<a name="460" href="#460">460</a> public synchronized void setProxyCredentials(

470

<a name="461" href="#461">461</a> String realm,

471

<a name="462" href="#462">462</a> String proxyHost,

472

<a name="463" href="#463">463</a> <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> credentials

473

<a name="464" href="#464">464</a> ) {

474

<a name="465" href="#465">465</a> LOG.trace("enter HttpState.setProxyCredentials(String, String, Credentials");

475

<a name="466" href="#466">466</a> proxyCred.put(new <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(proxyHost, AuthScope.ANY_PORT, realm, AuthScope.ANY_SCHEME), credentials);

476

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

477

478

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

479

<a name="470" href="#470">470</a> * Sets the {@link Credentials proxy credentials} for the given authentication

480

<a name="471" href="#471">471</a> * realm. Any previous credentials for the given realm will be overwritten.

481

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

482

<a name="473" href="#473">473</a> * @param authscope the {@link AuthScope authentication scope}

483

<a name="474" href="#474">474</a> * @param credentials the authentication {@link Credentials credentials}

484

<a name="475" href="#475">475</a> * for the given realm.

485

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

486

<a name="477" href="#477">477</a> * @see #getProxyCredentials(AuthScope)

487

<a name="478" href="#478">478</a> * @see #setCredentials(AuthScope, Credentials)

488

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

489

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

490

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

491

<a name="482" href="#482">482</a> public synchronized void setProxyCredentials(final <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope,

492

<a name="483" href="#483">483</a> final <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> credentials)

493

<a name="484" href="#484">484</a> {

494

<a name="485" href="#485">485</a> if (authscope == null) {

495

<a name="486" href="#486">486</a> throw new IllegalArgumentException("Authentication scope may not be null");

496

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

497

<a name="488" href="#488">488</a> LOG.trace("enter HttpState.setProxyCredentials(AuthScope, Credentials)");

498

<a name="489" href="#489">489</a> proxyCred.put(authscope, credentials);

499

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

500

501

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

502

<a name="493" href="#493">493</a> * Get the {@link Credentials credentials} for the proxy host with the given

503

<a name="494" href="#494">494</a> * authentication scope.

504

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

505

<a name="496" href="#496">496</a> * If the realm exists on host, return the coresponding credentials.

506

<a name="497" href="#497">497</a> * If the host exists with a <tt>null</tt> realm, return the corresponding

507

<a name="498" href="#498">498</a> * credentials.

508

<a name="499" href="#499">499</a> * If the realm exists with a <tt>null</tt> host, return the

509

<a name="500" href="#500">500</a> * corresponding credentials. If the realm does not exist, return

510

<a name="501" href="#501">501</a> * the default Credentials. If there are no default credentials, return

511

<a name="502" href="#502">502</a> * <code>null</code>.

512

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

513

<a name="504" href="#504">504</a> * @param realm the authentication realm

514

<a name="505" href="#505">505</a> * @param proxyHost the proxy host the realm is on

515

<a name="506" href="#506">506</a> * @return the credentials

516

<a name="507" href="#507">507</a> * @see #setProxyCredentials(String, String, Credentials)

517

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

518

<a name="509" href="#509">509</a> * @deprecated use #getProxyCredentials(AuthScope)

519

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

520

<a name="511" href="#511">511</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> getProxyCredentials(String realm, String proxyHost) {

521

<a name="512" href="#512">512</a> LOG.trace("enter HttpState.getCredentials(String, String");

522

<a name="513" href="#513">513</a> return matchCredentials(this.proxyCred,

523

<a name="514" href="#514">514</a> new <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(proxyHost, AuthScope.ANY_PORT, realm, AuthScope.ANY_SCHEME));

524

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

525

526

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

527

<a name="518" href="#518">518</a> * Get the {@link Credentials proxy credentials} for the given authentication scope.

528

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

529

<a name="520" href="#520">520</a> * @param authscope the {@link AuthScope authentication scope}

530

<a name="521" href="#521">521</a> * @return the credentials

531

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

532

<a name="523" href="#523">523</a> * @see #setProxyCredentials(AuthScope, Credentials)

533

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

534

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

535

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

536

<a name="527" href="#527">527</a> public synchronized <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> getProxyCredentials(final <a href="../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope) {

537

<a name="528" href="#528">528</a> if (authscope == null) {

538

<a name="529" href="#529">529</a> throw new IllegalArgumentException("Authentication scope may not be null");

539

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

540

<a name="531" href="#531">531</a> LOG.trace("enter HttpState.getProxyCredentials(AuthScope)");

541

<a name="532" href="#532">532</a> return matchCredentials(this.proxyCred, authscope);

542

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

543

544

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

545

<a name="536" href="#536">536</a> * Returns a string representation of this HTTP state.

546

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

547

<a name="538" href="#538">538</a> * @return The string representation of the HTTP state.

548

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

549

<a name="540" href="#540">540</a> * @see java.lang.Object#toString()

550

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

551

<a name="542" href="#542">542</a> public synchronized String toString() {

552

<a name="543" href="#543">543</a> StringBuffer sbResult = new StringBuffer();

553

554

<a name="545" href="#545">545</a> sbResult.append("[");

555

<a name="546" href="#546">546</a> sbResult.append(getCredentialsStringRepresentation(proxyCred));

556

<a name="547" href="#547">547</a> sbResult.append(" | ");

557

<a name="548" href="#548">548</a> sbResult.append(getCredentialsStringRepresentation(credMap));

558

<a name="549" href="#549">549</a> sbResult.append(" | ");

559

<a name="550" href="#550">550</a> sbResult.append(getCookiesStringRepresentation(cookies));

560

<a name="551" href="#551">551</a> sbResult.append("]");

561

562

<a name="553" href="#553">553</a> String strResult = sbResult.toString();

563

564

<a name="555" href="#555">555</a> return strResult;

565

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

566

567

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

568

<a name="559" href="#559">559</a> * Returns a string representation of the credentials.

569

<a name="560" href="#560">560</a> * @param credMap The credentials.

570

<a name="561" href="#561">561</a> * @return The string representation.

571

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

572

<a name="563" href="#563">563</a> private static String getCredentialsStringRepresentation(final Map credMap) {

573

<a name="564" href="#564">564</a> StringBuffer sbResult = new StringBuffer();

574

<a name="565" href="#565">565</a> Iterator iter = credMap.keySet().iterator();

575

<a name="566" href="#566">566</a> while (iter.hasNext()) {

576

<a name="567" href="#567">567</a> Object key = iter.next();

577

<a name="568" href="#568">568</a> <a href="../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> cred = (Credentials) credMap.get(key);

578

<a name="569" href="#569">569</a> if (sbResult.length() > 0) {

579

<a name="570" href="#570">570</a> sbResult.append(", ");

580

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

581

<a name="572" href="#572">572</a> sbResult.append(key);

582

<a name="573" href="#573">573</a> sbResult.append("#");

583

<a name="574" href="#574">574</a> sbResult.append(cred.toString());

584

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

585

<a name="576" href="#576">576</a> return sbResult.toString();

586

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

587

588

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

589

<a name="580" href="#580">580</a> * Returns a string representation of the cookies.

590

<a name="581" href="#581">581</a> * @param cookies The cookies

591

<a name="582" href="#582">582</a> * @return The string representation.

592

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

593

<a name="584" href="#584">584</a> private static String getCookiesStringRepresentation(final List cookies) {

594

<a name="585" href="#585">585</a> StringBuffer sbResult = new StringBuffer();

595

<a name="586" href="#586">586</a> Iterator iter = cookies.iterator();

596

<a name="587" href="#587">587</a> while (iter.hasNext()) {

597

<a name="588" href="#588">588</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> ck = (Cookie) iter.next();

598

<a name="589" href="#589">589</a> if (sbResult.length() > 0) {

599

<a name="590" href="#590">590</a> sbResult.append("#");

600

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

601

<a name="592" href="#592">592</a> sbResult.append(ck.toExternalForm());

602

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

603

<a name="594" href="#594">594</a> return sbResult.toString();

604

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

605

606

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

607

<a name="598" href="#598">598</a> * Clears all credentials.

608

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

609

<a name="600" href="#600">600</a> public void clearCredentials() {

610

<a name="601" href="#601">601</a> this.credMap.clear();

611

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

612

613

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

614

<a name="605" href="#605">605</a> * Clears all proxy credentials.

615

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

616

<a name="607" href="#607">607</a> public void clearProxyCredentials() {

617

<a name="608" href="#608">608</a> this.proxyCred.clear();

618

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

619

620

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

621

<a name="612" href="#612">612</a> * Clears all cookies.

622

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

623

<a name="614" href="#614">614</a> public synchronized void clearCookies() {

624

<a name="615" href="#615">615</a> this.cookies.clear();

625

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

626

627

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

628

<a name="619" href="#619">619</a> * Clears the state information (all cookies, credentials and proxy credentials).

629

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

630

<a name="621" href="#621">621</a> public void clear() {

631

<a name="622" href="#622">622</a> clearCookies();

632

<a name="623" href="#623">623</a> clearCredentials();

633

<a name="624" href="#624">624</a> clearProxyCredentials();

634

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

635

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

636

</pre>

637

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

638

</html>

639

Older »