~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/HeaderElement.java,v 1.23 2004/05/13 04:03:25 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.util.ArrayList;

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

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

<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> * One element of an HTTP header's value.

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

<a name="43" href="#43">43</a> * Some HTTP headers (such as the set-cookie header) have values that

<a name="44" href="#44">44</a> * can be decomposed into multiple elements. Such headers must be in the

<a name="45" href="#45">45</a> * following form:

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

<a name="48" href="#48">48</a> * header = [ element ] *( "," [ element ] )

<a name="49" href="#49">49</a> * element = name [ "=" [ value ] ] *( ";" [ param ] )

<a name="50" href="#50">50</a> * param = name [ "=" [ value ] ]

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

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

<a name="53" href="#53">53</a> * value = ( token | quoted-string )

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

<a name="55" href="#55">55</a> * token = 1*&lt;any char except "=", ",", ";", &lt;"&gt; and

<a name="56" href="#56">56</a> * white space&gt;

<a name="57" href="#57">57</a> * quoted-string = &lt;"&gt; *( text | quoted-char ) &lt;"&gt;

<a name="58" href="#58">58</a> * text = any char except &lt;"&gt;

<a name="59" href="#59">59</a> * quoted-char = "\" char

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

<a name="62" href="#62">62</a> * Any amount of white space is allowed between any part of the

<a name="63" href="#63">63</a> * header, element or param and is ignored. A missing value in any

<a name="64" href="#64">64</a> * element or param will be stored as the empty {@link String};

<a name="65" href="#65">65</a> * if the "=" is also missing <var>null</var> will be stored instead.

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

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

<a name="68" href="#68">68</a> * This class represents an individual header element, containing

<a name="69" href="#69">69</a> * both a name/value pair (value may be <tt>null</tt>) and optionally

<a name="70" href="#70">70</a> * a set of additional parameters.

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

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

<a name="73" href="#73">73</a> * This class also exposes a {@link #parse} method for parsing a

<a name="74" href="#74">74</a> * {@link Header} value into an array of elements.

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

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

<a name="77" href="#77">77</a> * @see Header

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

<a name="79" href="#79">79</a> * @author <a href="<a href="mailto:bcholmes@interlog.com" target="alexandria_uri">mailto:bcholmes@interlog.com</a>">B.C. Holmes</a>

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

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

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

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

<a name="84" href="#84">84</a> * @since 1.0

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

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

<a name="87" href="#87">87</a> public class <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a> extends <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> {

<a name="89" href="#89">89</a> // ----------------------------------------------------------- Constructors

100

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

101

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

102

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

103

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

104

<a name="95" href="#95">95</a> this(null, null, null);

105

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

106

107

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

108

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

109

<a name="100" href="#100">100</a> * @param name my name

110

<a name="101" href="#101">101</a> * @param value my (possibly <tt>null</tt>) value

111

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

112

<a name="103" href="#103">103</a> public <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(String name, String value) {

113

<a name="104" href="#104">104</a> this(name, value, null);

114

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

115

116

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

117

<a name="108" href="#108">108</a> * Constructor with name, value and parameters.

118

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

119

<a name="110" href="#110">110</a> * @param name my name

120

<a name="111" href="#111">111</a> * @param value my (possibly <tt>null</tt>) value

121

<a name="112" href="#112">112</a> * @param parameters my (possibly <tt>null</tt>) parameters

122

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

123

<a name="114" href="#114">114</a> public <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(String name, String value,

124

<a name="115" href="#115">115</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] parameters) {

125

<a name="116" href="#116">116</a> super(name, value);

126

<a name="117" href="#117">117</a> this.parameters = parameters;

127

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

128

129

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

130

<a name="121" href="#121">121</a> * Constructor with array of characters.

131

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

132

<a name="123" href="#123">123</a> * @param chars the array of characters

133

<a name="124" href="#124">124</a> * @param offset - the initial offset.

134

<a name="125" href="#125">125</a> * @param length - the length.

135

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

136

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

137

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

138

<a name="129" href="#129">129</a> public <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(char[] chars, int offset, int length) {

139

<a name="130" href="#130">130</a> this();

140

<a name="131" href="#131">131</a> if (chars == null) {

141

<a name="132" href="#132">132</a> return;

142

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

143

<a name="134" href="#134">134</a> <a href="../../../../org/apache/commons/httpclient/util/ParameterParser.html">ParameterParser</a> parser = new <a href="../../../../org/apache/commons/httpclient/util/ParameterParser.html">ParameterParser</a>();

144

<a name="135" href="#135">135</a> List params = parser.parse(chars, offset, length, ';');

145

<a name="136" href="#136">136</a> if (params.size() > 0) {

146

<a name="137" href="#137">137</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> element = (NameValuePair) params.remove(0);

147

<a name="138" href="#138">138</a> setName(element.getName());

148

<a name="139" href="#139">139</a> setValue(element.getValue());

149

<a name="140" href="#140">140</a> if (params.size() > 0) {

150

<a name="141" href="#141">141</a> this.parameters = (NameValuePair[])

151

<a name="142" href="#142">142</a> params.toArray(new <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[params.size()]);

152

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

153

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

154

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

155

156

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

157

<a name="148" href="#148">148</a> * Constructor with array of characters.

158

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

159

<a name="150" href="#150">150</a> * @param chars the array of characters

160

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

161

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

162

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

163

<a name="154" href="#154">154</a> public <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(char[] chars) {

164

<a name="155" href="#155">155</a> this(chars, 0, chars.length);

165

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

166

167

<a name="158" href="#158">158</a> // -------------------------------------------------------- Constants

168

169

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

170

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

171

172

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

173

174

<a name="165" href="#165">165</a> /** My parameters, if any. */

175

<a name="166" href="#166">166</a> private <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] parameters = null;

176

177

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

178

179

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

180

<a name="171" href="#171">171</a> * Get parameters, if any.

181

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

182

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

183

<a name="174" href="#174">174</a> * @return parameters as an array of {@link NameValuePair}s

184

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

185

<a name="176" href="#176">176</a> public <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] getParameters() {

186

<a name="177" href="#177">177</a> return this.parameters;

187

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

188

189

<a name="180" href="#180">180</a> // --------------------------------------------------------- Public Methods

190

191

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

192

<a name="183" href="#183">183</a> * This parses the value part of a header. The result is an array of

193

<a name="184" href="#184">184</a> * HeaderElement objects.

194

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

195

<a name="186" href="#186">186</a> * @param headerValue the array of char representation of the header value

196

<a name="187" href="#187">187</a> * (as received from the web server).

197

<a name="188" href="#188">188</a> * @return array of {@link HeaderElement}s.

198

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

199

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

200

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

201

<a name="192" href="#192">192</a> public static final <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] parseElements(char[] headerValue) {

202

203

<a name="194" href="#194">194</a> LOG.trace("enter HeaderElement.parseElements(char[])");

204

205

<a name="196" href="#196">196</a> if (headerValue == null) {

206

<a name="197" href="#197">197</a> return new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] {};

207

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

208

<a name="199" href="#199">199</a> List elements = new ArrayList();

209

210

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

211

<a name="202" href="#202">202</a> int from = 0;

212

<a name="203" href="#203">203</a> int len = headerValue.length;

213

<a name="204" href="#204">204</a> boolean qouted = false;

214

<a name="205" href="#205">205</a> while (i < len) {

215

<a name="206" href="#206">206</a> char ch = headerValue[i];

216

<a name="207" href="#207">207</a> if (ch == '"') {

217

<a name="208" href="#208">208</a> qouted = !qouted;

218

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

219

<a name="210" href="#210">210</a> <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a> element = null;

220

<a name="211" href="#211">211</a> if ((!qouted) && (ch == ',')) {

221

<a name="212" href="#212">212</a> element = new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(headerValue, from, i);

222

<a name="213" href="#213">213</a> from = i + 1;

223

<a name="214" href="#214">214</a> } else if (i == len - 1) {

224

<a name="215" href="#215">215</a> element = new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>(headerValue, from, len);

225

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

226

<a name="217" href="#217">217</a> if ((element != null) && (element.getName() != null)) {

227

<a name="218" href="#218">218</a> elements.add(element);

228

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

229

<a name="220" href="#220">220</a> i++;

230

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

231

<a name="222" href="#222">222</a> return (HeaderElement[])

232

<a name="223" href="#223">223</a> elements.toArray(new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[elements.size()]);

233

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

234

235

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

236

<a name="227" href="#227">227</a> * This parses the value part of a header. The result is an array of

237

<a name="228" href="#228">228</a> * HeaderElement objects.

238

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

239

<a name="230" href="#230">230</a> * @param headerValue the string representation of the header value

240

<a name="231" href="#231">231</a> * (as received from the web server).

241

<a name="232" href="#232">232</a> * @return array of {@link HeaderElement}s.

242

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

243

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

244

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

245

<a name="236" href="#236">236</a> public static final <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] parseElements(String headerValue) {

246

247

<a name="238" href="#238">238</a> LOG.trace("enter HeaderElement.parseElements(String)");

248

249

<a name="240" href="#240">240</a> if (headerValue == null) {

250

<a name="241" href="#241">241</a> return new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] {};

251

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

252

<a name="243" href="#243">243</a> return parseElements(headerValue.toCharArray());

253

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

254

255

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

256

<a name="247" href="#247">247</a> * This parses the value part of a header. The result is an array of

257

<a name="248" href="#248">248</a> * HeaderElement objects.

258

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

259

<a name="250" href="#250">250</a> * @param headerValue the string representation of the header value

260

<a name="251" href="#251">251</a> * (as received from the web server).

261

<a name="252" href="#252">252</a> * @return array of {@link HeaderElement}s.

262

<a name="253" href="#253">253</a> * @throws HttpException if the above syntax rules are violated.

263

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

264

<a name="255" href="#255">255</a> * @deprecated Use #parseElements(String).

265

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

266

<a name="257" href="#257">257</a> public static final <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] parse(String headerValue)

267

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

268

269

<a name="260" href="#260">260</a> LOG.trace("enter HeaderElement.parse(String)");

270

271

<a name="262" href="#262">262</a> if (headerValue == null) {

272

<a name="263" href="#263">263</a> return new <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] {};

273

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

274

<a name="265" href="#265">265</a> return parseElements(headerValue.toCharArray());

275

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

276

277

278

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

279

<a name="270" href="#270">270</a> * Returns parameter with the given name, if found. Otherwise null

280

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

281

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

282

<a name="273" href="#273">273</a> * @param name The name to search by.

283

<a name="274" href="#274">274</a> * @return NameValuePair parameter with the given name

284

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

285

286

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

287

288

<a name="279" href="#279">279</a> LOG.trace("enter HeaderElement.getParameterByName(String)");

289

290

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

291

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

292

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

293

<a name="284" href="#284">284</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> found = null;

294

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

295

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

296

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

297

<a name="288" href="#288">288</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> current = parameters[ i ];

298

<a name="289" href="#289">289</a> if (current.getName().equalsIgnoreCase(name)) {

299

<a name="290" href="#290">290</a> found = current;

300

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

301

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

302

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

303

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

304

<a name="295" href="#295">295</a> return found;

305

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

306

307

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

308

309

</pre>

310

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

311

</html>

312

Older »