1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>ExpectContinueMethod xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/httpclient/methods/ExpectContinueMethod.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/ExpectContinueMethod.java,v 1.13 2004/05/08 10:12:08 olegk Exp $</em>
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 480424 $</em>
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $</em>
<a name="5" href="#5">5</a> <em class="comment"> *</em>
<a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="9" href="#9">9</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a name="10" href="#10">10</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="11" href="#11">11</a> <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="12" href="#12">12</a> <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="13" href="#13">13</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
<a name="14" href="#14">14</a> <em class="comment"> *</em>
<a name="15" href="#15">15</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>
<a name="16" href="#16">16</a> <em class="comment"> *</em>
<a name="17" href="#17">17</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="18" href="#18">18</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="19" href="#19">19</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="20" href="#20">20</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="21" href="#21">21</a> <em class="comment"> * limitations under the License.</em>
<a name="22" href="#22">22</a> <em class="comment"> * ====================================================================</em>
<a name="23" href="#23">23</a> <em class="comment"> *</em>
<a name="24" href="#24">24</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="25" href="#25">25</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
<a name="26" href="#26">26</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
<a name="27" href="#27">27</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
<a name="28" href="#28">28</a> <em class="comment"> *</em>
<a name="29" href="#29">29</a> <em class="comment"> */</em>
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <strong>package</strong> org.apache.commons.httpclient.methods;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <strong>import</strong> java.io.IOException;
<a name="34" href="#34">34</a> <strong>import</strong> org.apache.commons.httpclient.HttpConnection;
<a name="35" href="#35">35</a> <strong>import</strong> org.apache.commons.httpclient.HttpException;
<a name="36" href="#36">36</a> <strong>import</strong> org.apache.commons.httpclient.HttpMethodBase;
<a name="37" href="#37">37</a> <strong>import</strong> org.apache.commons.httpclient.HttpState;
<a name="38" href="#38">38</a> <strong>import</strong> org.apache.commons.httpclient.HttpVersion;
<a name="39" href="#39">39</a> <strong>import</strong> org.apache.commons.httpclient.params.HttpMethodParams;
<a name="40" href="#40">40</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="41" href="#41">41</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em>/**</em>
<a name="44" href="#44">44</a> <em> * <p></em>
<a name="45" href="#45">45</a> <em> * This abstract class serves as a foundation for all HTTP methods </em>
<a name="46" href="#46">46</a> <em> * that support 'Expect: 100-continue' handshake.</em>
<a name="47" href="#47">47</a> <em> * </p></em>
<a name="48" href="#48">48</a> <em> * </em>
<a name="49" href="#49">49</a> <em> * <p></em>
<a name="50" href="#50">50</a> <em> * The purpose of the 100 (Continue) status (refer to section 10.1.1 </em>
<a name="51" href="#51">51</a> <em> * of the RFC 2616 for more details) is to allow a client that is </em>
<a name="52" href="#52">52</a> <em> * sending a request message with a request body to determine if the </em>
<a name="53" href="#53">53</a> <em> * origin server is willing to accept the request (based on the request </em>
<a name="54" href="#54">54</a> <em> * headers) before the client sends the request body. In some cases,</em>
<a name="55" href="#55">55</a> <em> * it might either be inappropriate or highly inefficient for the </em>
<a name="56" href="#56">56</a> <em> * client to send the body if the server will reject the message </em>
<a name="57" href="#57">57</a> <em> * without looking at the body.</em>
<a name="58" href="#58">58</a> <em> * </p></em>
<a name="59" href="#59">59</a> <em> * </em>
<a name="60" href="#60">60</a> <em> * <p></em>
<a name="61" href="#61">61</a> <em> * 'Expect: 100-continue' handshake should be used with caution,</em>
<a name="62" href="#62">62</a> <em> * as it may cause problems with HTTP servers and proxies that</em>
<a name="63" href="#63">63</a> <em> * do not support HTTP/1.1 protocol.</em>
<a name="64" href="#64">64</a> <em> * </p></em>
<a name="65" href="#65">65</a> <em> * </em>
<a name="66" href="#66">66</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
<a name="67" href="#67">67</a> <em> *</em>
<a name="68" href="#68">68</a> <em> * @since 2.0beta1</em>
<a name="69" href="#69">69</a> <em> */</em>
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/apache/commons/httpclient/methods/ExpectContinueMethod.html">ExpectContinueMethod</a> <strong>extends</strong> <a href="../../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a> {
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <em>/**</em><em> LOG object for this class. */</em>
<a name="74" href="#74">74</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Log LOG = LogFactory.getLog(ExpectContinueMethod.<strong>class</strong>);
<a name="75" href="#75">75</a>
<a name="76" href="#76">76</a> <em>/**</em>
<a name="77" href="#77">77</a> <em> * No-arg constructor.</em>
<a name="78" href="#78">78</a> <em> *</em>
<a name="79" href="#79">79</a> <em> * @since 2.0</em>
<a name="80" href="#80">80</a> <em> */</em>
<a name="81" href="#81">81</a> <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/methods/ExpectContinueMethod.html">ExpectContinueMethod</a>() {
<a name="82" href="#82">82</a> <strong>super</strong>();
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> <em>/**</em>
<a name="86" href="#86">86</a> <em> * Constructor specifying a URI.</em>
<a name="87" href="#87">87</a> <em> *</em>
<a name="88" href="#88">88</a> <em> * @param uri either an absolute or relative URI</em>
<a name="89" href="#89">89</a> <em> *</em>
<a name="90" href="#90">90</a> <em> * @since 2.0</em>
<a name="91" href="#91">91</a> <em> */</em>
<a name="92" href="#92">92</a> <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/methods/ExpectContinueMethod.html">ExpectContinueMethod</a>(String uri) {
<a name="93" href="#93">93</a> <strong>super</strong>(uri);
<a name="94" href="#94">94</a> }
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em>/**</em>
<a name="97" href="#97">97</a> <em> * <p></em>
<a name="98" href="#98">98</a> <em> * Returns <tt>true</tt> if the 'Expect: 100-Continue' handshake</em>
<a name="99" href="#99">99</a> <em> * is activated. The purpose of the 'Expect: 100-Continue' </em>
<a name="100" href="#100">100</a> <em> * handshake to allow a client that is sending a request message </em>
<a name="101" href="#101">101</a> <em> * with a request body to determine if the origin server is </em>
<a name="102" href="#102">102</a> <em> * willing to accept the request (based on the request headers) </em>
<a name="103" href="#103">103</a> <em> * before the client sends the request body.</em>
<a name="104" href="#104">104</a> <em> * </p></em>
<a name="105" href="#105">105</a> <em> * </em>
<a name="106" href="#106">106</a> <em> * @return <tt>true</tt> if 'Expect: 100-Continue' handshake is to</em>
<a name="107" href="#107">107</a> <em> * be used, <tt>false</tt> otherwise.</em>
<a name="108" href="#108">108</a> <em> * </em>
<a name="109" href="#109">109</a> <em> * @since 2.0beta1</em>
<a name="110" href="#110">110</a> <em> * </em>
<a name="111" href="#111">111</a> <em> * @deprecated Use {@link HttpMethodParams}</em>
<a name="112" href="#112">112</a> <em> * </em>
<a name="113" href="#113">113</a> <em> * @see #getParams()</em>
<a name="114" href="#114">114</a> <em> * @see HttpMethodParams</em>
<a name="115" href="#115">115</a> <em> * @see HttpMethodParams#USE_EXPECT_CONTINUE</em>
<a name="116" href="#116">116</a> <em> */</em>
<a name="117" href="#117">117</a> <strong>public</strong> <strong>boolean</strong> getUseExpectHeader() {
<a name="118" href="#118">118</a> <strong>return</strong> getParams().getBooleanParameter(HttpMethodParams.USE_EXPECT_CONTINUE, false);
<a name="119" href="#119">119</a> }
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a> <em>/**</em>
<a name="122" href="#122">122</a> <em> * <p></em>
<a name="123" href="#123">123</a> <em> * Activates 'Expect: 100-Continue' handshake. The purpose of </em>
<a name="124" href="#124">124</a> <em> * the 'Expect: 100-Continue' handshake to allow a client that is </em>
<a name="125" href="#125">125</a> <em> * sending a request message with a request body to determine if </em>
<a name="126" href="#126">126</a> <em> * the origin server is willing to accept the request (based on </em>
<a name="127" href="#127">127</a> <em> * the request headers) before the client sends the request body.</em>
<a name="128" href="#128">128</a> <em> * </p></em>
<a name="129" href="#129">129</a> <em> * </em>
<a name="130" href="#130">130</a> <em> * <p></em>
<a name="131" href="#131">131</a> <em> * The use of the 'Expect: 100-continue' handshake can result in </em>
<a name="132" href="#132">132</a> <em> * noticable peformance improvement for entity enclosing requests</em>
<a name="133" href="#133">133</a> <em> * (such as POST and PUT) that require the target server's </em>
<a name="134" href="#134">134</a> <em> * authentication.</em>
<a name="135" href="#135">135</a> <em> * </p></em>
<a name="136" href="#136">136</a> <em> * </em>
<a name="137" href="#137">137</a> <em> * <p></em>
<a name="138" href="#138">138</a> <em> * 'Expect: 100-continue' handshake should be used with </em>
<a name="139" href="#139">139</a> <em> * caution, as it may cause problems with HTTP servers and </em>
<a name="140" href="#140">140</a> <em> * proxies that do not support HTTP/1.1 protocol.</em>
<a name="141" href="#141">141</a> <em> * </p></em>
<a name="142" href="#142">142</a> <em> * </em>
<a name="143" href="#143">143</a> <em> * @param value boolean value</em>
<a name="144" href="#144">144</a> <em> * </em>
<a name="145" href="#145">145</a> <em> * @since 2.0beta1</em>
<a name="146" href="#146">146</a> <em> * </em>
<a name="147" href="#147">147</a> <em> * @deprecated Use {@link HttpMethodParams}</em>
<a name="148" href="#148">148</a> <em> * </em>
<a name="149" href="#149">149</a> <em> * @see #getParams()</em>
<a name="150" href="#150">150</a> <em> * @see HttpMethodParams</em>
<a name="151" href="#151">151</a> <em> * @see HttpMethodParams#USE_EXPECT_CONTINUE</em>
<a name="152" href="#152">152</a> <em> */</em>
<a name="153" href="#153">153</a> <strong>public</strong> <strong>void</strong> setUseExpectHeader(<strong>boolean</strong> value) {
<a name="154" href="#154">154</a> getParams().setBooleanParameter(HttpMethodParams.USE_EXPECT_CONTINUE, value);
<a name="155" href="#155">155</a> }
<a name="156" href="#156">156</a>
<a name="157" href="#157">157</a> <em>/**</em>
<a name="158" href="#158">158</a> <em> * Returns <tt>true</tt> if there is a request body to be sent.</em>
<a name="159" href="#159">159</a> <em> * 'Expect: 100-continue' handshake may not be used if request</em>
<a name="160" href="#160">160</a> <em> * body is not present</em>
<a name="161" href="#161">161</a> <em> * </em>
<a name="162" href="#162">162</a> <em> * @return boolean</em>
<a name="163" href="#163">163</a> <em> * </em>
<a name="164" href="#164">164</a> <em> * @since 2.0beta1</em>
<a name="165" href="#165">165</a> <em> */</em>
<a name="166" href="#166">166</a> <strong>protected</strong> <strong>abstract</strong> <strong>boolean</strong> hasRequestContent();
<a name="167" href="#167">167</a>
<a name="168" href="#168">168</a> <em>/**</em>
<a name="169" href="#169">169</a> <em> * Sets the <tt>Expect</tt> header if it has not already been set, </em>
<a name="170" href="#170">170</a> <em> * in addition to the "standard" set of headers.</em>
<a name="171" href="#171">171</a> <em> *</em>
<a name="172" href="#172">172</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="173" href="#173">173</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="174" href="#174">174</a> <em> * this HTTP method</em>
<a name="175" href="#175">175</a> <em> *</em>
<a name="176" href="#176">176</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="177" href="#177">177</a> <em> * can be recovered from.</em>
<a name="178" href="#178">178</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="179" href="#179">179</a> <em> * cannot be recovered from.</em>
<a name="180" href="#180">180</a> <em> */</em>
<a name="181" href="#181">181</a> <strong>protected</strong> <strong>void</strong> addRequestHeaders(<a href="../../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="182" href="#182">182</a> throws IOException, <a href="../../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="183" href="#183">183</a> LOG.trace(<span class="string">"enter ExpectContinueMethod.addRequestHeaders(HttpState, HttpConnection)"</span>);
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> <strong>super</strong>.addRequestHeaders(state, conn);
<a name="186" href="#186">186</a> <em class="comment">// If the request is being retried, the header may already be present</em>
<a name="187" href="#187">187</a> <strong>boolean</strong> headerPresent = (getRequestHeader(<span class="string">"Expect"</span>) != <strong>null</strong>);
<a name="188" href="#188">188</a> <em class="comment">// See if the expect header should be sent</em>
<a name="189" href="#189">189</a> <em class="comment">// = HTTP/1.1 or higher</em>
<a name="190" href="#190">190</a> <em class="comment">// = request body present</em>
<a name="191" href="#191">191</a>
<a name="192" href="#192">192</a> <strong>if</strong> (getParams().isParameterTrue(HttpMethodParams.USE_EXPECT_CONTINUE)
<a name="193" href="#193">193</a> && getEffectiveVersion().greaterEquals(HttpVersion.HTTP_1_1)
<a name="194" href="#194">194</a> && hasRequestContent())
<a name="195" href="#195">195</a> {
<a name="196" href="#196">196</a> <strong>if</strong> (!headerPresent) {
<a name="197" href="#197">197</a> setRequestHeader(<span class="string">"Expect"</span>, <span class="string">"100-continue"</span>);
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a> } <strong>else</strong> {
<a name="200" href="#200">200</a> <strong>if</strong> (headerPresent) {
<a name="201" href="#201">201</a> removeRequestHeader(<span class="string">"Expect"</span>);
<a name="202" href="#202">202</a> }
<a name="203" href="#203">203</a> }
<a name="204" href="#204">204</a> }
<a name="205" href="#205">205</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
|
