~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

<a name="2" href="#2">2</a> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/cookie/CookieSpecBase.java,v 1.16.2.3 2004/02/22 18:21:15 olegk Exp $

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

<a name="4" href="#4">4</a> * $Date: 2004/02/22 18:21:15 $

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

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

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

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

<a name="10" href="#10">10</a> * Licensed under the Apache License, Version 2.0 (the "License");

<a name="11" href="#11">11</a> * you may not use this file except in compliance with the License.

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

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

<a name="14" href="#14">14</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="15" href="#15">15</a> *

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

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

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

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

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

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

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

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

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

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

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

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

<a name="28" href="#28">28</a> * [Additional notices, if required by prior licensing conditions]

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

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

<a name="32" href="#32">32</a> package <a href="../../../../../org/apache/commons/httpclient/cookie/package-summary.html">org.apache.commons.httpclient.cookie</a>;

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

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

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

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

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

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

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

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

<a name="43" href="#43">43</a> import org.apache.commons.httpclient.util.DateParseException;

<a name="44" href="#44">44</a> import org.apache.commons.httpclient.util.DateParser;

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

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

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

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

<a name="50" href="#50">50</a> * Cookie management functions shared by all specification.

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

<a name="52" href="#52">52</a> * @author B.C. Holmes

<a name="53" href="#53">53</a> * @author <a href="<a href="mailto:jericho@thinkfree.com" target="alexandria_uri">mailto:jericho@thinkfree.com</a>">Park, Sung-Gu</a>

<a name="54" href="#54">54</a> * @author <a href="<a href="mailto:dsale@us.britannica.com" target="alexandria_uri">mailto:dsale@us.britannica.com</a>">Doug Sale</a>

<a name="55" href="#55">55</a> * @author Rod Waldhoff

<a name="56" href="#56">56</a> * @author dIon Gillard

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

<a name="58" href="#58">58</a> * @author <a href="<a href="mailto:JEvans@Cyveillance.com" target="alexandria_uri">mailto:JEvans@Cyveillance.com</a>">John Evans</a>

<a name="59" href="#59">59</a> * @author Marc A. Saegesser

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

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

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

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

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

<a name="65" href="#65">65</a> public class <a href="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html">CookieSpecBase</a> implements <a href="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> {

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

<a name="68" href="#68">68</a> protected static final Log LOG = LogFactory.getLog(CookieSpec.class);

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

<a name="71" href="#71">71</a> public <a href="../../../../../org/apache/commons/httpclient/cookie/CookieSpecBase.html">CookieSpecBase</a>() {

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

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

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

<a name="77" href="#77">77</a> * Parses the Set-Cookie value into an array of <tt>Cookie</tt>s.

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

<a name="79" href="#79">79</a> * The syntax for the Set-Cookie response header is:

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

<a name="82" href="#82">82</a> * set-cookie = "Set-Cookie:" cookies

<a name="83" href="#83">83</a> * cookies = 1#cookie

<a name="84" href="#84">84</a> * cookie = NAME "=" VALUE * (";" cookie-av)

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

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

<a name="87" href="#87">87</a> * cookie-av = "Comment" "=" value

<a name="88" href="#88">88</a> * | "Domain" "=" value

<a name="89" href="#89">89</a> * | "Max-Age" "=" value

<a name="90" href="#90">90</a> * | "Path" "=" value

100

<a name="91" href="#91">91</a> * | "Secure"

101

<a name="92" href="#92">92</a> * | "Version" "=" 1*DIGIT

102

103

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

104

<a name="95" href="#95">95</a> * @param host the host from which the <tt>Set-Cookie</tt> value was

105

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

106

<a name="97" href="#97">97</a> * @param port the port from which the <tt>Set-Cookie</tt> value was

107

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

108

<a name="99" href="#99">99</a> * @param path the path from which the <tt>Set-Cookie</tt> value was

109

<a name="100" href="#100">100</a> * received

110

<a name="101" href="#101">101</a> * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> value was

111

<a name="102" href="#102">102</a> * received over secure conection

112

<a name="103" href="#103">103</a> * @param header the <tt>Set-Cookie</tt> received from the server

113

<a name="104" href="#104">104</a> * @return an array of <tt>Cookie</tt>s parsed from the Set-Cookie value

114

<a name="105" href="#105">105</a> * @throws MalformedCookieException if an exception occurs during parsing

115

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

116

<a name="107" href="#107">107</a> public <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] parse(String host, int port, String path,

117

<a name="108" href="#108">108</a> boolean secure, final String header)

118

<a name="109" href="#109">109</a> throws <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> {

119

120

<a name="111" href="#111">111</a> LOG.trace("enter CookieSpecBase.parse("

121

<a name="112" href="#112">112</a> + "String, port, path, boolean, Header)");

122

123

<a name="114" href="#114">114</a> if (host == null) {

124

<a name="115" href="#115">115</a> throw new IllegalArgumentException(

125

<a name="116" href="#116">116</a> "Host of origin may not be null");

126

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

127

<a name="118" href="#118">118</a> if (host.trim().equals("")) {

128

<a name="119" href="#119">119</a> throw new IllegalArgumentException(

129

<a name="120" href="#120">120</a> "Host of origin may not be blank");

130

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

131

<a name="122" href="#122">122</a> if (port < 0) {

132

<a name="123" href="#123">123</a> throw new IllegalArgumentException("Invalid port: " + port);

133

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

134

<a name="125" href="#125">125</a> if (path == null) {

135

<a name="126" href="#126">126</a> throw new IllegalArgumentException(

136

<a name="127" href="#127">127</a> "Path of origin may not be null.");

137

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

138

<a name="129" href="#129">129</a> if (header == null) {

139

<a name="130" href="#130">130</a> throw new IllegalArgumentException("Header may not be null.");

140

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

141

142

<a name="133" href="#133">133</a> if (path.trim().equals("")) {

143

<a name="134" href="#134">134</a> path = PATH_DELIM;

144

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

145

<a name="136" href="#136">136</a> host = host.toLowerCase();

146

147

<a name="138" href="#138">138</a> <a href="../../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] headerElements = null;

148

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

149

<a name="140" href="#140">140</a> headerElements = HeaderElement.parse(header);

150

<a name="141" href="#141">141</a> } catch (HttpException e) {

151

<a name="142" href="#142">142</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(e.getMessage());

152

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

153

154

<a name="145" href="#145">145</a> String defaultPath = path;

155

<a name="146" href="#146">146</a> int lastSlashIndex = defaultPath.lastIndexOf(PATH_DELIM);

156

<a name="147" href="#147">147</a> if (lastSlashIndex >= 0) {

157

<a name="148" href="#148">148</a> if (lastSlashIndex == 0) {

158

<a name="149" href="#149">149</a> //Do not remove the very first slash

159

<a name="150" href="#150">150</a> lastSlashIndex = 1;

160

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

161

<a name="152" href="#152">152</a> defaultPath = defaultPath.substring(0, lastSlashIndex);

162

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

163

164

<a name="155" href="#155">155</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies = new <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[headerElements.length];

165

166

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

167

168

<a name="159" href="#159">159</a> <a href="../../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a> headerelement = headerElements[i];

169

<a name="160" href="#160">160</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie = null;

170

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

171

<a name="162" href="#162">162</a> cookie = new <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>(host,

172

<a name="163" href="#163">163</a> headerelement.getName(),

173

<a name="164" href="#164">164</a> headerelement.getValue(),

174

<a name="165" href="#165">165</a> defaultPath,

175

<a name="166" href="#166">166</a> null,

176

<a name="167" href="#167">167</a> false);

177

<a name="168" href="#168">168</a> } catch (IllegalArgumentException e) {

178

<a name="169" href="#169">169</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(e.getMessage());

179

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

180

<a name="171" href="#171">171</a> // cycle through the parameters

181

<a name="172" href="#172">172</a> <a href="../../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] parameters = headerelement.getParameters();

182

<a name="173" href="#173">173</a> // could be null. In case only a header element and no parameters.

183

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

184

185

<a name="176" href="#176">176</a> for (int j = 0; j < parameters.length; j++) {

186

<a name="177" href="#177">177</a> parseAttribute(parameters[j], cookie);

187

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

188

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

189

<a name="180" href="#180">180</a> cookies[i] = cookie;

190

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

191

<a name="182" href="#182">182</a> return cookies;

192

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

193

194

195

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

196

<a name="187" href="#187">187</a> * Parse the <tt>"Set-Cookie"</tt> {@link Header} into an array of {@link

197

<a name="188" href="#188">188</a> * Cookie}s.

198

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

199

<a name="190" href="#190">190</a> * The syntax for the Set-Cookie response header is:

200

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

201

202

<a name="193" href="#193">193</a> * set-cookie = "Set-Cookie:" cookies

203

<a name="194" href="#194">194</a> * cookies = 1#cookie

204

<a name="195" href="#195">195</a> * cookie = NAME "=" VALUE * (";" cookie-av)

205

<a name="196" href="#196">196</a> * NAME = attr

206

<a name="197" href="#197">197</a> * VALUE = value

207

<a name="198" href="#198">198</a> * cookie-av = "Comment" "=" value

208

<a name="199" href="#199">199</a> * | "Domain" "=" value

209

<a name="200" href="#200">200</a> * | "Max-Age" "=" value

210

<a name="201" href="#201">201</a> * | "Path" "=" value

211

<a name="202" href="#202">202</a> * | "Secure"

212

<a name="203" href="#203">203</a> * | "Version" "=" 1*DIGIT

213

214

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

215

<a name="206" href="#206">206</a> * @param host the host from which the <tt>Set-Cookie</tt> header was

216

<a name="207" href="#207">207</a> * received

217

<a name="208" href="#208">208</a> * @param port the port from which the <tt>Set-Cookie</tt> header was

218

<a name="209" href="#209">209</a> * received

219

<a name="210" href="#210">210</a> * @param path the path from which the <tt>Set-Cookie</tt> header was

220

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

221

<a name="212" href="#212">212</a> * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header was

222

<a name="213" href="#213">213</a> * received over secure conection

223

<a name="214" href="#214">214</a> * @param header the <tt>Set-Cookie</tt> received from the server

224

<a name="215" href="#215">215</a> * @return an array of <tt>Cookie</tt>s parsed from the <tt>"Set-Cookie"

225

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

226

<a name="217" href="#217">217</a> * @throws MalformedCookieException if an exception occurs during parsing

227

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

228

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

229

<a name="220" href="#220">220</a> String host, int port, String path, boolean secure, final <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a> header)

230

<a name="221" href="#221">221</a> throws <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> {

231

232

<a name="223" href="#223">223</a> LOG.trace("enter CookieSpecBase.parse("

233

<a name="224" href="#224">224</a> + "String, port, path, boolean, String)");

234

<a name="225" href="#225">225</a> if (header == null) {

235

<a name="226" href="#226">226</a> throw new IllegalArgumentException("Header may not be null.");

236

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

237

<a name="228" href="#228">228</a> return parse(host, port, path, secure, header.getValue());

238

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

239

240

241

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

242

<a name="233" href="#233">233</a> * Parse the cookie attribute and update the corresponsing {@link Cookie}

243

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

244

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

245

<a name="236" href="#236">236</a> * @param attribute {@link HeaderElement} cookie attribute from the

246

<a name="237" href="#237">237</a> * <tt>Set- Cookie</tt>

247

<a name="238" href="#238">238</a> * @param cookie {@link Cookie} to be updated

248

<a name="239" href="#239">239</a> * @throws MalformedCookieException if an exception occurs during parsing

249

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

250

251

<a name="242" href="#242">242</a> public void parseAttribute(

252

<a name="243" href="#243">243</a> final <a href="../../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> attribute, final <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie)

253

<a name="244" href="#244">244</a> throws <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> {

254

255

<a name="246" href="#246">246</a> if (attribute == null) {

256

<a name="247" href="#247">247</a> throw new IllegalArgumentException("Attribute may not be null.");

257

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

258

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

259

<a name="250" href="#250">250</a> throw new IllegalArgumentException("Cookie may not be null.");

260

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

261

<a name="252" href="#252">252</a> final String paramName = attribute.getName().toLowerCase();

262

<a name="253" href="#253">253</a> String paramValue = attribute.getValue();

263

264

<a name="255" href="#255">255</a> if (paramName.equals("path")) {

265

266

<a name="257" href="#257">257</a> if ((paramValue == null) || (paramValue.trim().equals(""))) {

267

<a name="258" href="#258">258</a> paramValue = "/";

268

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

269

<a name="260" href="#260">260</a> cookie.setPath(paramValue);

270

<a name="261" href="#261">261</a> cookie.setPathAttributeSpecified(true);

271

272

<a name="263" href="#263">263</a> } else if (paramName.equals("domain")) {

273

274

<a name="265" href="#265">265</a> if (paramValue == null) {

275

<a name="266" href="#266">266</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

276

<a name="267" href="#267">267</a> "Missing value for domain attribute");

277

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

278

<a name="269" href="#269">269</a> if (paramValue.trim().equals("")) {

279

<a name="270" href="#270">270</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

280

<a name="271" href="#271">271</a> "Blank value for domain attribute");

281

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

282

<a name="273" href="#273">273</a> cookie.setDomain(paramValue);

283

<a name="274" href="#274">274</a> cookie.setDomainAttributeSpecified(true);

284

285

<a name="276" href="#276">276</a> } else if (paramName.equals("max-age")) {

286

287

<a name="278" href="#278">278</a> if (paramValue == null) {

288

<a name="279" href="#279">279</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

289

<a name="280" href="#280">280</a> "Missing value for max-age attribute");

290

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

291

<a name="282" href="#282">282</a> int age;

292

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

293

<a name="284" href="#284">284</a> age = Integer.parseInt(paramValue);

294

<a name="285" href="#285">285</a> } catch (NumberFormatException e) {

295

<a name="286" href="#286">286</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> ("Invalid max-age "

296

<a name="287" href="#287">287</a> + "attribute: " + e.getMessage());

297

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

298

<a name="289" href="#289">289</a> cookie.setExpiryDate(

299

<a name="290" href="#290">290</a> new Date(System.currentTimeMillis() + age * 1000L));

300

301

<a name="292" href="#292">292</a> } else if (paramName.equals("secure")) {

302

303

<a name="294" href="#294">294</a> cookie.setSecure(true);

304

305

<a name="296" href="#296">296</a> } else if (paramName.equals("comment")) {

306

307

<a name="298" href="#298">298</a> cookie.setComment(paramValue);

308

309

<a name="300" href="#300">300</a> } else if (paramName.equals("expires")) {

310

311

<a name="302" href="#302">302</a> if (paramValue == null) {

312

<a name="303" href="#303">303</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

313

<a name="304" href="#304">304</a> "Missing value for expires attribute");

314

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

315

<a name="306" href="#306">306</a> // trim single quotes around expiry if present

316

<a name="307" href="#307">307</a> // see http://nagoya.apache.org/bugzilla/show_bug.cgi?id=5279

317

<a name="308" href="#308">308</a> if (paramValue.length() > 1

318

<a name="309" href="#309">309</a> && paramValue.startsWith("'")

319

<a name="310" href="#310">310</a> && paramValue.endsWith("'")) {

320

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

321

<a name="312" href="#312">312</a> = paramValue.substring (1, paramValue.length() - 1);

322

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

323

324

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

325

<a name="316" href="#316">316</a> cookie.setExpiryDate(DateParser.parseDate(paramValue));

326

<a name="317" href="#317">317</a> } catch (DateParseException dpe) {

327

<a name="318" href="#318">318</a> LOG.debug("Error parsing cookie date", dpe);

328

<a name="319" href="#319">319</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

329

<a name="320" href="#320">320</a> "Unable to parse expiration date parameter: "

330

<a name="321" href="#321">321</a> + paramValue);

331

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

332

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

333

<a name="324" href="#324">324</a> if (LOG.isDebugEnabled()) {

334

<a name="325" href="#325">325</a> LOG.debug("Unrecognized cookie attribute: "

335

<a name="326" href="#326">326</a> + attribute.toString());

336

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

337

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

338

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

339

340

341

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

342

<a name="333" href="#333">333</a> * Performs most common {@link Cookie} validation

343

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

344

<a name="335" href="#335">335</a> * @param host the host from which the {@link Cookie} was received

345

<a name="336" href="#336">336</a> * @param port the port from which the {@link Cookie} was received

346

<a name="337" href="#337">337</a> * @param path the path from which the {@link Cookie} was received

347

<a name="338" href="#338">338</a> * @param secure <tt>true</tt> when the {@link Cookie} was received using a

348

<a name="339" href="#339">339</a> * secure connection

349

<a name="340" href="#340">340</a> * @param cookie The cookie to validate.

350

<a name="341" href="#341">341</a> * @throws MalformedCookieException if an exception occurs during

351

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

352

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

353

354

<a name="345" href="#345">345</a> public void validate(String host, int port, String path,

355

<a name="346" href="#346">346</a> boolean secure, final <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie)

356

<a name="347" href="#347">347</a> throws <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> {

357

358

<a name="349" href="#349">349</a> LOG.trace("enter CookieSpecBase.validate("

359

<a name="350" href="#350">350</a> + "String, port, path, boolean, Cookie)");

360

<a name="351" href="#351">351</a> if (host == null) {

361

<a name="352" href="#352">352</a> throw new IllegalArgumentException(

362

<a name="353" href="#353">353</a> "Host of origin may not be null");

363

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

364

<a name="355" href="#355">355</a> if (host.trim().equals("")) {

365

<a name="356" href="#356">356</a> throw new IllegalArgumentException(

366

<a name="357" href="#357">357</a> "Host of origin may not be blank");

367

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

368

<a name="359" href="#359">359</a> if (port < 0) {

369

<a name="360" href="#360">360</a> throw new IllegalArgumentException("Invalid port: " + port);

370

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

371

<a name="362" href="#362">362</a> if (path == null) {

372

<a name="363" href="#363">363</a> throw new IllegalArgumentException(

373

<a name="364" href="#364">364</a> "Path of origin may not be null.");

374

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

375

<a name="366" href="#366">366</a> if (path.trim().equals("")) {

376

<a name="367" href="#367">367</a> path = PATH_DELIM;

377

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

378

<a name="369" href="#369">369</a> host = host.toLowerCase();

379

<a name="370" href="#370">370</a> // check version

380

<a name="371" href="#371">371</a> if (cookie.getVersion() < 0) {

381

<a name="372" href="#372">372</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a> ("Illegal version number "

382

<a name="373" href="#373">373</a> + cookie.getValue());

383

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

384

385

<a name="376" href="#376">376</a> // security check... we musn't allow the server to give us an

386

<a name="377" href="#377">377</a> // invalid domain scope

387

388

<a name="379" href="#379">379</a> // Validate the cookies domain attribute. NOTE: Domains without

389

<a name="380" href="#380">380</a> // any dots are allowed to support hosts on private LANs that don't

390

<a name="381" href="#381">381</a> // have DNS names. Since they have no dots, to domain-match the

391

<a name="382" href="#382">382</a> // request-host and domain must be identical for the cookie to sent

392

<a name="383" href="#383">383</a> // back to the origin-server.

393

<a name="384" href="#384">384</a> if (host.indexOf(".") >= 0) {

394

<a name="385" href="#385">385</a> // Not required to have at least two dots. RFC 2965.

395

<a name="386" href="#386">386</a> // A Set-Cookie2 with Domain=ajax.com will be accepted.

396

397

<a name="388" href="#388">388</a> // domain must match host

398

<a name="389" href="#389">389</a> if (!host.endsWith(cookie.getDomain())) {

399

<a name="390" href="#390">390</a> String s = cookie.getDomain();

400

<a name="391" href="#391">391</a> if (s.startsWith(".")) {

401

<a name="392" href="#392">392</a> s = s.substring(1, s.length());

402

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

403

<a name="394" href="#394">394</a> if (!host.equals(s)) {

404

<a name="395" href="#395">395</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

405

<a name="396" href="#396">396</a> "Illegal domain attribute \"" + cookie.getDomain()

406

<a name="397" href="#397">397</a> + "\". Domain of origin: \"" + host + "\"");

407

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

408

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

409

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

410

<a name="401" href="#401">401</a> if (!host.equals(cookie.getDomain())) {

411

<a name="402" href="#402">402</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

412

<a name="403" href="#403">403</a> "Illegal domain attribute \"" + cookie.getDomain()

413

<a name="404" href="#404">404</a> + "\". Domain of origin: \"" + host + "\"");

414

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

415

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

416

417

<a name="408" href="#408">408</a> // another security check... we musn't allow the server to give us a

418

<a name="409" href="#409">409</a> // cookie that doesn't match this path

419

420

<a name="411" href="#411">411</a> if (!path.startsWith(cookie.getPath())) {

421

<a name="412" href="#412">412</a> throw new <a href="../../../../../org/apache/commons/httpclient/cookie/MalformedCookieException.html">MalformedCookieException</a>(

422

<a name="413" href="#413">413</a> "Illegal path attribute \"" + cookie.getPath()

423

<a name="414" href="#414">414</a> + "\". Path of origin: \"" + path + "\"");

424

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

425

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

426

427

428

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

429

<a name="420" href="#420">420</a> * Return <tt>true</tt> if the cookie should be submitted with a request

430

<a name="421" href="#421">421</a> * with given attributes, <tt>false</tt> otherwise.

431

<a name="422" href="#422">422</a> * @param host the host to which the request is being submitted

432

<a name="423" href="#423">423</a> * @param port the port to which the request is being submitted (ignored)

433

<a name="424" href="#424">424</a> * @param path the path to which the request is being submitted

434

<a name="425" href="#425">425</a> * @param secure <tt>true</tt> if the request is using a secure connection

435

<a name="426" href="#426">426</a> * @param cookie {@link Cookie} to be matched

436

<a name="427" href="#427">427</a> * @return true if the cookie matches the criterium

437

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

438

439

<a name="430" href="#430">430</a> public boolean match(String host, int port, String path,

440

<a name="431" href="#431">431</a> boolean secure, final <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) {

441

442

<a name="433" href="#433">433</a> LOG.trace("enter CookieSpecBase.match("

443

<a name="434" href="#434">434</a> + "String, int, String, boolean, Cookie");

444

445

<a name="436" href="#436">436</a> if (host == null) {

446

<a name="437" href="#437">437</a> throw new IllegalArgumentException(

447

<a name="438" href="#438">438</a> "Host of origin may not be null");

448

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

449

<a name="440" href="#440">440</a> if (host.trim().equals("")) {

450

<a name="441" href="#441">441</a> throw new IllegalArgumentException(

451

<a name="442" href="#442">442</a> "Host of origin may not be blank");

452

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

453

<a name="444" href="#444">444</a> if (port < 0) {

454

<a name="445" href="#445">445</a> throw new IllegalArgumentException("Invalid port: " + port);

455

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

456

<a name="447" href="#447">447</a> if (path == null) {

457

<a name="448" href="#448">448</a> throw new IllegalArgumentException(

458

<a name="449" href="#449">449</a> "Path of origin may not be null.");

459

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

460

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

461

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

462

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

463

<a name="454" href="#454">454</a> if (path.trim().equals("")) {

464

<a name="455" href="#455">455</a> path = PATH_DELIM;

465

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

466

<a name="457" href="#457">457</a> host = host.toLowerCase();

467

<a name="458" href="#458">458</a> if (cookie.getDomain() == null) {

468

<a name="459" href="#459">459</a> LOG.warn("Invalid cookie state: domain not specified");

469

<a name="460" href="#460">460</a> return false;

470

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

471

<a name="462" href="#462">462</a> if (cookie.getPath() == null) {

472

<a name="463" href="#463">463</a> LOG.warn("Invalid cookie state: path not specified");

473

<a name="464" href="#464">464</a> return false;

474

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

475

476

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

477

<a name="468" href="#468">468</a> // only add the cookie if it hasn't yet expired

478

<a name="469" href="#469">469</a> (cookie.getExpiryDate() == null

479

<a name="470" href="#470">470</a> || cookie.getExpiryDate().after(new Date()))

480

<a name="471" href="#471">471</a> // and the domain pattern matches

481

<a name="472" href="#472">472</a> && (domainMatch(host, cookie.getDomain()))

482

<a name="473" href="#473">473</a> // and the path is null or matching

483

<a name="474" href="#474">474</a> && (pathMatch(path, cookie.getPath()))

484

<a name="475" href="#475">475</a> // and if the secure flag is set, only if the request is

485

<a name="476" href="#476">476</a> // actually secure

486

<a name="477" href="#477">477</a> && (cookie.getSecure() ? secure : true);

487

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

488

489

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

490

<a name="481" href="#481">481</a> * Performs a domain-match as described in RFC2109.

491

<a name="482" href="#482">482</a> * @param host The host to check.

492

<a name="483" href="#483">483</a> * @param domain The domain.

493

<a name="484" href="#484">484</a> * @return true if the specified host matches the given domain.

494

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

495

<a name="486" href="#486">486</a> private static boolean domainMatch(String host, String domain) {

496

<a name="487" href="#487">487</a> boolean match = host.equals(domain)

497

<a name="488" href="#488">488</a> || (domain.startsWith(".") && host.endsWith(domain));

498

499

<a name="490" href="#490">490</a> return match;

500

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

501

502

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

503

<a name="494" href="#494">494</a> * Performs a path-match slightly smarter than a straight-forward startsWith

504

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

505

<a name="496" href="#496">496</a> * @param path The path to check.

506

<a name="497" href="#497">497</a> * @param topmostPath The path to check against.

507

<a name="498" href="#498">498</a> * @return true if the paths match

508

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

509

<a name="500" href="#500">500</a> private static boolean pathMatch(

510

<a name="501" href="#501">501</a> final String path, final String topmostPath) {

511

512

<a name="503" href="#503">503</a> boolean match = path.startsWith (topmostPath);

513

514

<a name="505" href="#505">505</a> // if there is a match and these values are not exactly the same we have

515

<a name="506" href="#506">506</a> // to make sure we're not matcing "/foobar" and "/foo"

516

<a name="507" href="#507">507</a> if (match && path.length() != topmostPath.length()) {

517

<a name="508" href="#508">508</a> if (!topmostPath.endsWith(PATH_DELIM)) {

518

<a name="509" href="#509">509</a> match = (path.charAt(topmostPath.length()) == PATH_DELIM_CHAR);

519

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

520

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

521

<a name="512" href="#512">512</a> return match;

522

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

523

524

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

525

<a name="516" href="#516">516</a> * Return an array of {@link Cookie}s that should be submitted with a

526

<a name="517" href="#517">517</a> * request with given attributes, <tt>false</tt> otherwise.

527

<a name="518" href="#518">518</a> * @param host the host to which the request is being submitted

528

<a name="519" href="#519">519</a> * @param port the port to which the request is being submitted (currently

529

<a name="520" href="#520">520</a> * ignored)

530

<a name="521" href="#521">521</a> * @param path the path to which the request is being submitted

531

<a name="522" href="#522">522</a> * @param secure <tt>true</tt> if the request is using a secure protocol

532

<a name="523" href="#523">523</a> * @param cookies an array of <tt>Cookie</tt>s to be matched

533

<a name="524" href="#524">524</a> * @return an array of <tt>Cookie</tt>s matching the criterium

534

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

535

536

<a name="527" href="#527">527</a> public <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] match(String host, int port, String path,

537

<a name="528" href="#528">528</a> boolean secure, final <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookies[]) {

538

539

<a name="530" href="#530">530</a> LOG.trace("enter CookieSpecBase.match("

540

<a name="531" href="#531">531</a> + "String, int, String, boolean, Cookie[])");

541

542

<a name="533" href="#533">533</a> if (host == null) {

543

<a name="534" href="#534">534</a> throw new IllegalArgumentException(

544

<a name="535" href="#535">535</a> "Host of origin may not be null");

545

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

546

<a name="537" href="#537">537</a> if (host.trim().equals("")) {

547

<a name="538" href="#538">538</a> throw new IllegalArgumentException(

548

<a name="539" href="#539">539</a> "Host of origin may not be blank");

549

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

550

<a name="541" href="#541">541</a> if (port < 0) {

551

<a name="542" href="#542">542</a> throw new IllegalArgumentException("Invalid port: " + port);

552

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

553

<a name="544" href="#544">544</a> if (path == null) {

554

<a name="545" href="#545">545</a> throw new IllegalArgumentException(

555

<a name="546" href="#546">546</a> "Path of origin may not be null.");

556

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

557

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

558

<a name="549" href="#549">549</a> throw new IllegalArgumentException("Cookie array may not be null");

559

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

560

<a name="551" href="#551">551</a> if (path.trim().equals("")) {

561

<a name="552" href="#552">552</a> path = PATH_DELIM;

562

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

563

<a name="554" href="#554">554</a> host = host.toLowerCase();

564

565

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

566

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

567

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

568

<a name="559" href="#559">559</a> List matching = new LinkedList();

569

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

570

<a name="561" href="#561">561</a> if (match(host, port, path, secure, cookies[i])) {

571

<a name="562" href="#562">562</a> addInPathOrder(matching, cookies[i]);

572

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

573

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

574

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

575

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

576

577

578

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

579

<a name="570" href="#570">570</a> * Adds the given cookie into the given list in descending path order. That

580

<a name="571" href="#571">571</a> * is, more specific path to least specific paths. This may not be the

581

<a name="572" href="#572">572</a> * fastest algorythm, but it'll work OK for the small number of cookies

582

<a name="573" href="#573">573</a> * we're generally dealing with.

583

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

584

<a name="575" href="#575">575</a> * @param list - the list to add the cookie to

585

<a name="576" href="#576">576</a> * @param addCookie - the Cookie to add to list

586

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

587

<a name="578" href="#578">578</a> private static void addInPathOrder(List list, <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> addCookie) {

588

<a name="579" href="#579">579</a> int i = 0;

589

590

<a name="581" href="#581">581</a> for (i = 0; i < list.size(); i++) {

591

<a name="582" href="#582">582</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> c = (Cookie) list.get(i);

592

<a name="583" href="#583">583</a> if (addCookie.compare(addCookie, c) > 0) {

593

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

594

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

595

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

596

<a name="587" href="#587">587</a> list.add(i, addCookie);

597

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

598

599

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

600

<a name="591" href="#591">591</a> * Return a string suitable for sending in a <tt>"Cookie"</tt> header

601

<a name="592" href="#592">592</a> * @param cookie a {@link Cookie} to be formatted as string

602

<a name="593" href="#593">593</a> * @return a string suitable for sending in a <tt>"Cookie"</tt> header.

603

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

604

<a name="595" href="#595">595</a> public String formatCookie(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) {

605

<a name="596" href="#596">596</a> LOG.trace("enter CookieSpecBase.formatCookie(Cookie)");

606

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

607

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

608

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

609

<a name="600" href="#600">600</a> StringBuffer buf = new StringBuffer();

610

<a name="601" href="#601">601</a> buf.append(cookie.getName());

611

<a name="602" href="#602">602</a> buf.append("=");

612

<a name="603" href="#603">603</a> String s = cookie.getValue();

613

<a name="604" href="#604">604</a> if (s != null) {

614

<a name="605" href="#605">605</a> buf.append(s);

615

<a name="606" href="#606">606</a> };

616

<a name="607" href="#607">607</a> return buf.toString();

617

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

618

619

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

620

<a name="611" href="#611">611</a> * Create a <tt>"Cookie"</tt> header value containing all {@link Cookie}s in

621

<a name="612" href="#612">612</a> * cookies suitable for sending in a <tt>"Cookie"</tt> header

622

<a name="613" href="#613">613</a> * @param cookies an array of {@link Cookie}s to be formatted

623

<a name="614" href="#614">614</a> * @return a string suitable for sending in a Cookie header.

624

<a name="615" href="#615">615</a> * @throws IllegalArgumentException if an input parameter is illegal

625

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

626

627

<a name="618" href="#618">618</a> public String formatCookies(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies)

628

<a name="619" href="#619">619</a> throws IllegalArgumentException {

629

<a name="620" href="#620">620</a> LOG.trace("enter CookieSpecBase.formatCookies(Cookie[])");

630

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

631

<a name="622" href="#622">622</a> throw new IllegalArgumentException("Cookie array may not be null");

632

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

633

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

634

<a name="625" href="#625">625</a> throw new IllegalArgumentException("Cookie array may not be empty");

635

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

636

637

<a name="628" href="#628">628</a> StringBuffer buffer = new StringBuffer();

638

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

639

<a name="630" href="#630">630</a> if (i > 0) {

640

<a name="631" href="#631">631</a> buffer.append("; ");

641

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

642

<a name="633" href="#633">633</a> buffer.append(formatCookie(cookies[i]));

643

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

644

<a name="635" href="#635">635</a> return buffer.toString();

645

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

646

647

648

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

649

<a name="640" href="#640">640</a> * Create a <tt>"Cookie"</tt> {@link Header} containing all {@link Cookie}s

650

<a name="641" href="#641">641</a> * in cookies.

651

<a name="642" href="#642">642</a> * @param cookies an array of {@link Cookie}s to be formatted as a <tt>"

652

<a name="643" href="#643">643</a> * Cookie"</tt> header

653

<a name="644" href="#644">644</a> * @return a <tt>"Cookie"</tt> {@link Header}.

654

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

655

<a name="646" href="#646">646</a> public <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a> formatCookieHeader(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies) {

656

<a name="647" href="#647">647</a> LOG.trace("enter CookieSpecBase.formatCookieHeader(Cookie[])");

657

<a name="648" href="#648">648</a> return new <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a>("Cookie", formatCookies(cookies));

658

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

659

660

661

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

662

<a name="653" href="#653">653</a> * Create a <tt>"Cookie"</tt> {@link Header} containing the {@link Cookie}.

663

<a name="654" href="#654">654</a> * @param cookie <tt>Cookie</tt>s to be formatted as a <tt>Cookie</tt>

664

<a name="655" href="#655">655</a> * header

665

<a name="656" href="#656">656</a> * @return a Cookie header.

666

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

667

<a name="658" href="#658">658</a> public <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a> formatCookieHeader(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) {

668

<a name="659" href="#659">659</a> LOG.trace("enter CookieSpecBase.formatCookieHeader(Cookie)");

669

<a name="660" href="#660">660</a> return new <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a>("Cookie", formatCookie(cookie));

670

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

671

672

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

673

</pre>

674

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

675

</html>

676

Older »