~ubuntu-branches/ubuntu/precise/commons-httpclient/precise-security

« back to all changes in this revision

Viewing changes to docs/xref-test/org/apache/commons/httpclient/server/SimpleRequest.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Meskes
  • Date: 2006-09-15 20:07:43 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060915200743-t2md4cgfsb07wgn7
Tags: 3.0.1-0.1
* Non-maintainer upload.
* Bump debhelper Build-Depends to (>= 4.1.0) as required by cdbs' 
  debhelper.mk
* Put the coppyright holders in debian/copyright
* Include the jar file in the package. (Closes: #381354)
* Only include one copy of the docs.
  done by James Westby <jw+debian@jameswestby.net>  Mon, 14 Aug 2006 02:29:47 +0100

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
3
<head>
 
4
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SimpleRequest xref</title>
 
5
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
 
6
</head>
 
7
<body>
 
8
<pre>
 
9
 
 
10
<a name="1" href="#1">1</a>   <em class="comment">/*</em>
 
11
<a name="2" href="#2">2</a>   <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/test/org/apache/commons/httpclient/server/SimpleRequest.java,v 1.3 2004/11/13 12:21:28 olegk Exp $</em>
 
12
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 155418 $</em>
 
13
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $</em>
 
14
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
 
15
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
 
16
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
 
17
<a name="8" href="#8">8</a>   <em class="comment"> *  Copyright 1999-2004 The Apache Software Foundation</em>
 
18
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
 
19
<a name="10" href="#10">10</a>  <em class="comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
 
20
<a name="11" href="#11">11</a>  <em class="comment"> *  you may not use this file except in compliance with the License.</em>
 
21
<a name="12" href="#12">12</a>  <em class="comment"> *  You may obtain a copy of the License at</em>
 
22
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
 
23
<a name="14" href="#14">14</a>  <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
 
24
<a name="15" href="#15">15</a>  <em class="comment"> *</em>
 
25
<a name="16" href="#16">16</a>  <em class="comment"> *  Unless required by applicable law or agreed to in writing, software</em>
 
26
<a name="17" href="#17">17</a>  <em class="comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
 
27
<a name="18" href="#18">18</a>  <em class="comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
 
28
<a name="19" href="#19">19</a>  <em class="comment"> *  See the License for the specific language governing permissions and</em>
 
29
<a name="20" href="#20">20</a>  <em class="comment"> *  limitations under the License.</em>
 
30
<a name="21" href="#21">21</a>  <em class="comment"> * ====================================================================</em>
 
31
<a name="22" href="#22">22</a>  <em class="comment"> *</em>
 
32
<a name="23" href="#23">23</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
 
33
<a name="24" href="#24">24</a>  <em class="comment"> * individuals on behalf of the Apache Software Foundation.  For more</em>
 
34
<a name="25" href="#25">25</a>  <em class="comment"> * information on the Apache Software Foundation, please see</em>
 
35
<a name="26" href="#26">26</a>  <em class="comment"> * &lt;<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
 
36
<a name="27" href="#27">27</a>  <em class="comment"> *</em>
 
37
<a name="28" href="#28">28</a>  <em class="comment"> */</em>
 
38
<a name="29" href="#29">29</a>  
 
39
<a name="30" href="#30">30</a>  <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/server/package-summary.html">org.apache.commons.httpclient.server</a>;
 
40
<a name="31" href="#31">31</a>  
 
41
<a name="32" href="#32">32</a>  <strong>import</strong> java.io.ByteArrayOutputStream;
 
42
<a name="33" href="#33">33</a>  <strong>import</strong> java.io.IOException;
 
43
<a name="34" href="#34">34</a>  <strong>import</strong> java.io.InputStream;
 
44
<a name="35" href="#35">35</a>  <strong>import</strong> java.util.Iterator;
 
45
<a name="36" href="#36">36</a>  
 
46
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.commons.httpclient.ChunkedInputStream;
 
47
<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.commons.httpclient.ContentLengthInputStream;
 
48
<a name="39" href="#39">39</a>  <strong>import</strong> org.apache.commons.httpclient.Header;
 
49
<a name="40" href="#40">40</a>  <strong>import</strong> org.apache.commons.httpclient.HeaderElement;
 
50
<a name="41" href="#41">41</a>  <strong>import</strong> org.apache.commons.httpclient.HeaderGroup;
 
51
<a name="42" href="#42">42</a>  <strong>import</strong> org.apache.commons.httpclient.NameValuePair;
 
52
<a name="43" href="#43">43</a>  
 
53
<a name="44" href="#44">44</a>  <em>/**<em>*</em></em>
 
54
<a name="45" href="#45">45</a>  <em> * A generic HTTP request.</em>
 
55
<a name="46" href="#46">46</a>  <em> * </em>
 
56
<a name="47" href="#47">47</a>  <em> * @author Oleg Kalnichevski</em>
 
57
<a name="48" href="#48">48</a>  <em> */</em>
 
58
<a name="49" href="#49">49</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/commons/httpclient/server/SimpleRequest.html">SimpleRequest</a> {
 
59
<a name="50" href="#50">50</a>      
 
60
<a name="51" href="#51">51</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String DEFAULT_CONTENT_CHARSET = <span class="string">"ISO-8859-1"</span>;
 
61
<a name="52" href="#52">52</a>      
 
62
<a name="53" href="#53">53</a>      <strong>private</strong> <a href="../../../../../org/apache/commons/httpclient/server/RequestLine.html">RequestLine</a> requestLine = <strong>null</strong>;
 
63
<a name="54" href="#54">54</a>      <strong>private</strong> HeaderGroup headers = <strong>new</strong> HeaderGroup();
 
64
<a name="55" href="#55">55</a>      <strong>private</strong> InputStream entity = <strong>null</strong>;
 
65
<a name="56" href="#56">56</a>  
 
66
<a name="57" href="#57">57</a>      <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/server/SimpleRequest.html">SimpleRequest</a>() {
 
67
<a name="58" href="#58">58</a>          <strong>super</strong>();
 
68
<a name="59" href="#59">59</a>      }
 
69
<a name="60" href="#60">60</a>  
 
70
<a name="61" href="#61">61</a>      <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/server/SimpleRequest.html">SimpleRequest</a>(
 
71
<a name="62" href="#62">62</a>          <strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/server/RequestLine.html">RequestLine</a> requestLine,
 
72
<a name="63" href="#63">63</a>          <strong>final</strong> Header[] headers,
 
73
<a name="64" href="#64">64</a>          <strong>final</strong> InputStream content) throws IOException
 
74
<a name="65" href="#65">65</a>      {
 
75
<a name="66" href="#66">66</a>          <strong>super</strong>();
 
76
<a name="67" href="#67">67</a>          <strong>if</strong> (requestLine == <strong>null</strong>) {
 
77
<a name="68" href="#68">68</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Request line may not be null"</span>);
 
78
<a name="69" href="#69">69</a>          }
 
79
<a name="70" href="#70">70</a>          <strong>this</strong>.requestLine = requestLine;
 
80
<a name="71" href="#71">71</a>          <strong>if</strong> (headers != <strong>null</strong>) {
 
81
<a name="72" href="#72">72</a>              <strong>this</strong>.headers.setHeaders(headers);
 
82
<a name="73" href="#73">73</a>          }
 
83
<a name="74" href="#74">74</a>          <strong>if</strong> (content != <strong>null</strong>) {
 
84
<a name="75" href="#75">75</a>              <em class="comment">// only PUT and POST have content</em>
 
85
<a name="76" href="#76">76</a>              String methodname = requestLine.getMethod(); 
 
86
<a name="77" href="#77">77</a>              <strong>if</strong> (<span class="string">"POST"</span>.equalsIgnoreCase(methodname) || <span class="string">"PUT"</span>.equalsIgnoreCase(methodname)) {
 
87
<a name="78" href="#78">78</a>                  Header contentLength = <strong>this</strong>.headers.getFirstHeader(<span class="string">"Content-Length"</span>);
 
88
<a name="79" href="#79">79</a>                  Header transferEncoding = <strong>this</strong>.headers.getFirstHeader(<span class="string">"Transfer-Encoding"</span>);
 
89
<a name="80" href="#80">80</a>                  InputStream in = content;
 
90
<a name="81" href="#81">81</a>                  <strong>if</strong> (transferEncoding != <strong>null</strong>) {
 
91
<a name="82" href="#82">82</a>                      <strong>if</strong> (transferEncoding.getValue().indexOf(<span class="string">"chunked"</span>) != -1) {
 
92
<a name="83" href="#83">83</a>                          in = <strong>new</strong> ChunkedInputStream(in);
 
93
<a name="84" href="#84">84</a>                      }
 
94
<a name="85" href="#85">85</a>                  } <strong>else</strong> <strong>if</strong> (contentLength != <strong>null</strong>) {
 
95
<a name="86" href="#86">86</a>                      <strong>long</strong> len = getContentLength();
 
96
<a name="87" href="#87">87</a>                      <strong>if</strong> (len >= 0) {
 
97
<a name="88" href="#88">88</a>                          in = <strong>new</strong> ContentLengthInputStream(in, len);
 
98
<a name="89" href="#89">89</a>                      }
 
99
<a name="90" href="#90">90</a>                  }
 
100
<a name="91" href="#91">91</a>                  <strong>this</strong>.entity = in;
 
101
<a name="92" href="#92">92</a>              }
 
102
<a name="93" href="#93">93</a>          }
 
103
<a name="94" href="#94">94</a>      }
 
104
<a name="95" href="#95">95</a>  
 
105
<a name="96" href="#96">96</a>      <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/server/SimpleRequest.html">SimpleRequest</a>(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/server/RequestLine.html">RequestLine</a> requestLine, <strong>final</strong> Header[] headers)
 
106
<a name="97" href="#97">97</a>          throws IOException {
 
107
<a name="98" href="#98">98</a>          <strong>this</strong>(requestLine, headers, <strong>null</strong>);
 
108
<a name="99" href="#99">99</a>      }
 
109
<a name="100" href="#100">100</a>     
 
110
<a name="101" href="#101">101</a>     <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/server/RequestLine.html">RequestLine</a> getRequestLine() {
 
111
<a name="102" href="#102">102</a>         <strong>return</strong> <strong>this</strong>.requestLine;
 
112
<a name="103" href="#103">103</a>     }
 
113
<a name="104" href="#104">104</a> 
 
114
<a name="105" href="#105">105</a>     <strong>public</strong> <strong>void</strong> setRequestLine(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/server/RequestLine.html">RequestLine</a> requestline) {
 
115
<a name="106" href="#106">106</a>         <strong>if</strong> (requestline == <strong>null</strong>) {
 
116
<a name="107" href="#107">107</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Request line may not be null"</span>);
 
117
<a name="108" href="#108">108</a>         }
 
118
<a name="109" href="#109">109</a>         <strong>this</strong>.requestLine = requestline;
 
119
<a name="110" href="#110">110</a>     }
 
120
<a name="111" href="#111">111</a> 
 
121
<a name="112" href="#112">112</a>     <strong>public</strong> <strong>boolean</strong> containsHeader(<strong>final</strong> String name) {
 
122
<a name="113" href="#113">113</a>         <strong>return</strong> <strong>this</strong>.headers.containsHeader(name);
 
123
<a name="114" href="#114">114</a>     }
 
124
<a name="115" href="#115">115</a> 
 
125
<a name="116" href="#116">116</a>     <strong>public</strong> Header[] getHeaders() {
 
126
<a name="117" href="#117">117</a>         <strong>return</strong> <strong>this</strong>.headers.getAllHeaders();
 
127
<a name="118" href="#118">118</a>     }
 
128
<a name="119" href="#119">119</a> 
 
129
<a name="120" href="#120">120</a>     <strong>public</strong> Header getFirstHeader(<strong>final</strong> String s) {
 
130
<a name="121" href="#121">121</a>         <strong>return</strong> <strong>this</strong>.headers.getFirstHeader(s);
 
131
<a name="122" href="#122">122</a>     }
 
132
<a name="123" href="#123">123</a> 
 
133
<a name="124" href="#124">124</a>     <strong>public</strong> <strong>void</strong> removeHeaders(<strong>final</strong> String s) {
 
134
<a name="125" href="#125">125</a>         <strong>if</strong> (s == <strong>null</strong>) {
 
135
<a name="126" href="#126">126</a>             <strong>return</strong>;
 
136
<a name="127" href="#127">127</a>         }
 
137
<a name="128" href="#128">128</a>         Header[] headers = <strong>this</strong>.headers.getHeaders(s);
 
138
<a name="129" href="#129">129</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; headers.length; i++) {
 
139
<a name="130" href="#130">130</a>             <strong>this</strong>.headers.removeHeader(headers[i]);
 
140
<a name="131" href="#131">131</a>         }
 
141
<a name="132" href="#132">132</a>     }
 
142
<a name="133" href="#133">133</a> 
 
143
<a name="134" href="#134">134</a>     <strong>public</strong> <strong>void</strong> addHeader(<strong>final</strong> Header header) {
 
144
<a name="135" href="#135">135</a>         <strong>if</strong> (header == <strong>null</strong>) {
 
145
<a name="136" href="#136">136</a>             <strong>return</strong>;
 
146
<a name="137" href="#137">137</a>         }
 
147
<a name="138" href="#138">138</a>         <strong>this</strong>.headers.addHeader(header);
 
148
<a name="139" href="#139">139</a>     }
 
149
<a name="140" href="#140">140</a> 
 
150
<a name="141" href="#141">141</a>     <strong>public</strong> <strong>void</strong> setHeader(<strong>final</strong> Header header) {
 
151
<a name="142" href="#142">142</a>         <strong>if</strong> (header == <strong>null</strong>) {
 
152
<a name="143" href="#143">143</a>             <strong>return</strong>;
 
153
<a name="144" href="#144">144</a>         }
 
154
<a name="145" href="#145">145</a>         removeHeaders(header.getName());
 
155
<a name="146" href="#146">146</a>         addHeader(header);
 
156
<a name="147" href="#147">147</a>     }
 
157
<a name="148" href="#148">148</a> 
 
158
<a name="149" href="#149">149</a>     <strong>public</strong> Iterator getHeaderIterator() {
 
159
<a name="150" href="#150">150</a>         <strong>return</strong> <strong>this</strong>.headers.getIterator();
 
160
<a name="151" href="#151">151</a>     }
 
161
<a name="152" href="#152">152</a> 
 
162
<a name="153" href="#153">153</a>     <strong>public</strong> String getContentType() {
 
163
<a name="154" href="#154">154</a>         Header contenttype = <strong>this</strong>.headers.getFirstHeader(<span class="string">"Content-Type"</span>);
 
164
<a name="155" href="#155">155</a>         <strong>if</strong> (contenttype != <strong>null</strong>) {
 
165
<a name="156" href="#156">156</a>             <strong>return</strong> contenttype.getValue(); 
 
166
<a name="157" href="#157">157</a>         } <strong>else</strong> {
 
167
<a name="158" href="#158">158</a>             <strong>return</strong> <span class="string">"text/plain"</span>; 
 
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
<a name="162" href="#162">162</a>     <strong>public</strong> String getCharset() {
 
172
<a name="163" href="#163">163</a>         String charset = <strong>null</strong>;
 
173
<a name="164" href="#164">164</a>         Header contenttype = <strong>this</strong>.headers.getFirstHeader(<span class="string">"Content-Type"</span>);
 
174
<a name="165" href="#165">165</a>         <strong>if</strong> (contenttype != <strong>null</strong>) {
 
175
<a name="166" href="#166">166</a>             HeaderElement values[] = contenttype.getElements();
 
176
<a name="167" href="#167">167</a>             <strong>if</strong> (values.length == 1) {
 
177
<a name="168" href="#168">168</a>                 NameValuePair param = values[0].getParameterByName(<span class="string">"charset"</span>);
 
178
<a name="169" href="#169">169</a>                 <strong>if</strong> (param != <strong>null</strong>) {
 
179
<a name="170" href="#170">170</a>                     charset = param.getValue();
 
180
<a name="171" href="#171">171</a>                 }
 
181
<a name="172" href="#172">172</a>             }
 
182
<a name="173" href="#173">173</a>         }
 
183
<a name="174" href="#174">174</a>         <strong>if</strong> (charset != <strong>null</strong>) {
 
184
<a name="175" href="#175">175</a>             <strong>return</strong> charset;
 
185
<a name="176" href="#176">176</a>         } <strong>else</strong> {
 
186
<a name="177" href="#177">177</a>             <strong>return</strong> DEFAULT_CONTENT_CHARSET;
 
187
<a name="178" href="#178">178</a>         }
 
188
<a name="179" href="#179">179</a>     }
 
189
<a name="180" href="#180">180</a>     
 
190
<a name="181" href="#181">181</a>     <strong>public</strong> <strong>long</strong> getContentLength() {
 
191
<a name="182" href="#182">182</a>         Header contentLength = <strong>this</strong>.headers.getFirstHeader(<span class="string">"Content-Length"</span>);
 
192
<a name="183" href="#183">183</a>         <strong>if</strong> (contentLength != <strong>null</strong>) {
 
193
<a name="184" href="#184">184</a>             <strong>try</strong> {
 
194
<a name="185" href="#185">185</a>                 <strong>return</strong> Long.parseLong(contentLength.getValue());
 
195
<a name="186" href="#186">186</a>             } <strong>catch</strong> (NumberFormatException e) {
 
196
<a name="187" href="#187">187</a>                 <strong>return</strong> -1;
 
197
<a name="188" href="#188">188</a>             }
 
198
<a name="189" href="#189">189</a>         } <strong>else</strong> {
 
199
<a name="190" href="#190">190</a>             <strong>return</strong> -1;
 
200
<a name="191" href="#191">191</a>         }
 
201
<a name="192" href="#192">192</a>     }
 
202
<a name="193" href="#193">193</a>     
 
203
<a name="194" href="#194">194</a>     <strong>public</strong> InputStream getBody() {
 
204
<a name="195" href="#195">195</a>         <strong>return</strong> <strong>this</strong>.entity;
 
205
<a name="196" href="#196">196</a>     }
 
206
<a name="197" href="#197">197</a>     
 
207
<a name="198" href="#198">198</a>     <strong>public</strong> byte[] getBodyBytes() throws IOException {
 
208
<a name="199" href="#199">199</a>         InputStream in = getBody();
 
209
<a name="200" href="#200">200</a>         <strong>if</strong> (in != <strong>null</strong>) {
 
210
<a name="201" href="#201">201</a>             byte[] tmp = <strong>new</strong> byte[4096];
 
211
<a name="202" href="#202">202</a>             <strong>int</strong> bytesRead = 0;
 
212
<a name="203" href="#203">203</a>             ByteArrayOutputStream buffer = <strong>new</strong> ByteArrayOutputStream(1024);
 
213
<a name="204" href="#204">204</a>             <strong>while</strong> ((bytesRead = in.read(tmp)) != -1) {
 
214
<a name="205" href="#205">205</a>                 buffer.write(tmp, 0, bytesRead);
 
215
<a name="206" href="#206">206</a>             }
 
216
<a name="207" href="#207">207</a>             <strong>return</strong> buffer.toByteArray();
 
217
<a name="208" href="#208">208</a>         } <strong>else</strong> {
 
218
<a name="209" href="#209">209</a>             <strong>return</strong> <strong>null</strong>;
 
219
<a name="210" href="#210">210</a>         }
 
220
<a name="211" href="#211">211</a>     }
 
221
<a name="212" href="#212">212</a>     
 
222
<a name="213" href="#213">213</a>     <strong>public</strong> String getBodyString() throws IOException {
 
223
<a name="214" href="#214">214</a>         byte[] raw = getBodyBytes();
 
224
<a name="215" href="#215">215</a>         <strong>if</strong> (raw != <strong>null</strong>) {
 
225
<a name="216" href="#216">216</a>             <strong>return</strong> <strong>new</strong> String(raw, getCharset());
 
226
<a name="217" href="#217">217</a>         } <strong>else</strong> {
 
227
<a name="218" href="#218">218</a>             <strong>return</strong> <strong>null</strong>;
 
228
<a name="219" href="#219">219</a>         }
 
229
<a name="220" href="#220">220</a>     }
 
230
<a name="221" href="#221">221</a> }
 
231
</pre>
 
232
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 
233
</html>
 
234