📄 httpmethodbase.html
字号:
<a name="152" href="#152">152</a> <em>/**<em>* True if this method has already been executed. */</em></em><a name="153" href="#153">153</a> <strong>private</strong> <strong>boolean</strong> used = false;<a name="154" href="#154">154</a> <a name="155" href="#155">155</a> <em>/**<em>* Count of how many times did this HTTP method transparently handle </em></em><a name="156" href="#156">156</a> <em> * a recoverable exception. */</em><a name="157" href="#157">157</a> <strong>private</strong> <strong>int</strong> recoverableExceptionCount = 0;<a name="158" href="#158">158</a> <a name="159" href="#159">159</a> <em>/**<em>* the host for this HTTP method, can be null */</em></em><a name="160" href="#160">160</a> <strong>private</strong> HttpHost httphost = <strong>null</strong>;<a name="161" href="#161">161</a> <a name="162" href="#162">162</a> <em>/**<em>*</em></em><a name="163" href="#163">163</a> <em> * Handles method retries</em><a name="164" href="#164">164</a> <em> * </em><a name="165" href="#165">165</a> <em> * @deprecated no loner used</em><a name="166" href="#166">166</a> <em> */</em><a name="167" href="#167">167</a> <strong>private</strong> MethodRetryHandler methodRetryHandler;<a name="168" href="#168">168</a> <a name="169" href="#169">169</a> <em>/**<em>* True if the connection must be closed when no longer needed */</em></em><a name="170" href="#170">170</a> <strong>private</strong> <strong>boolean</strong> connectionCloseForced = false;<a name="171" href="#171">171</a> <a name="172" href="#172">172</a> <em>/**<em>* Number of milliseconds to wait for 100-contunue response. */</em></em><a name="173" href="#173">173</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> RESPONSE_WAIT_TIME_MS = 3000;<a name="174" href="#174">174</a> <a name="175" href="#175">175</a> <em>/**<em>* HTTP protocol version used for execution of this method. */</em></em><a name="176" href="#176">176</a> <strong>private</strong> HttpVersion effectiveVersion = <strong>null</strong>;<a name="177" href="#177">177</a> <a name="178" href="#178">178</a> <em>/**<em>* Whether the execution of this method has been aborted */</em></em><a name="179" href="#179">179</a> <strong>private</strong> <strong>transient</strong> <strong>boolean</strong> aborted = false;<a name="180" href="#180">180</a> <a name="181" href="#181">181</a> <em>/**<em>* Whether the HTTP request has been transmitted to the target</em></em><a name="182" href="#182">182</a> <em> * server it its entirety */</em><a name="183" href="#183">183</a> <strong>private</strong> <strong>boolean</strong> requestSent = false;<a name="184" href="#184">184</a> <a name="185" href="#185">185</a> <em>/**<em>* Actual cookie policy */</em></em><a name="186" href="#186">186</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> cookiespec = <strong>null</strong>;<a name="187" href="#187">187</a> <a name="188" href="#188">188</a> <em>/**<em>* Default initial size of the response buffer if content length is unknown. */</em></em><a name="189" href="#189">189</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_INITIAL_BUFFER_SIZE = 4*1024; <em class="comment">// 4 kB</em><a name="190" href="#190">190</a> <a name="191" href="#191">191</a> <em class="comment">// ----------------------------------------------------------- Constructors</em><a name="192" href="#192">192</a> <a name="193" href="#193">193</a> <em>/**<em>*</em></em><a name="194" href="#194">194</a> <em> * No-arg constructor.</em><a name="195" href="#195">195</a> <em> */</em><a name="196" href="#196">196</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>() {<a name="197" href="#197">197</a> }<a name="198" href="#198">198</a> <a name="199" href="#199">199</a> <em>/**<em>*</em></em><a name="200" href="#200">200</a> <em> * Constructor specifying a URI.</em><a name="201" href="#201">201</a> <em> * It is responsibility of the caller to ensure that URI elements</em><a name="202" href="#202">202</a> <em> * (path & query parameters) are properly encoded (URL safe).</em><a name="203" href="#203">203</a> <em> *</em><a name="204" href="#204">204</a> <em> * @param uri either an absolute or relative URI. The URI is expected</em><a name="205" href="#205">205</a> <em> * to be URL-encoded</em><a name="206" href="#206">206</a> <em> * </em><a name="207" href="#207">207</a> <em> * @throws IllegalArgumentException when URI is invalid</em><a name="208" href="#208">208</a> <em> * @throws IllegalStateException when protocol of the absolute URI is not recognised</em><a name="209" href="#209">209</a> <em> */</em><a name="210" href="#210">210</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>(String uri) <a name="211" href="#211">211</a> throws IllegalArgumentException, IllegalStateException {<a name="212" href="#212">212</a> <a name="213" href="#213">213</a> <strong>try</strong> {<a name="214" href="#214">214</a> <a name="215" href="#215">215</a> <em class="comment">// create a URI and allow for null/empty uri values</em><a name="216" href="#216">216</a> <strong>if</strong> (uri == <strong>null</strong> || uri.equals(<span class="string">""</span>)) {<a name="217" href="#217">217</a> uri = <span class="string">"/"</span>;<a name="218" href="#218">218</a> }<a name="219" href="#219">219</a> <em class="comment">// BEGIN IA CHANGES</em><a name="220" href="#220">220</a> <em class="comment">// setURI(new URI(uri, true));</em><a name="221" href="#221">221</a> setURI(<strong>new</strong> org.archive.net.LaxURI(uri, <strong>true</strong>));<a name="222" href="#222">222</a> <em class="comment">// END IA CHANGES</em><a name="223" href="#223">223</a> } <strong>catch</strong> (URIException e) {<a name="224" href="#224">224</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid uri '"</span> <a name="225" href="#225">225</a> + uri + <span class="string">"': "</span> + e.getMessage() <a name="226" href="#226">226</a> );<a name="227" href="#227">227</a> }<a name="228" href="#228">228</a> }<a name="229" href="#229">229</a> <a name="230" href="#230">230</a> <em class="comment">// ------------------------------------------- Property Setters and Getters</em><a name="231" href="#231">231</a> <a name="232" href="#232">232</a> <em>/**<em>*</em></em><a name="233" href="#233">233</a> <em> * Obtains the name of the HTTP method as used in the HTTP request line,</em><a name="234" href="#234">234</a> <em> * for example <tt>"GET"</tt> or <tt>"POST"</tt>.</em><a name="235" href="#235">235</a> <em> * </em><a name="236" href="#236">236</a> <em> * @return the name of this method</em><a name="237" href="#237">237</a> <em> */</em><a name="238" href="#238">238</a> <strong>public</strong> <strong>abstract</strong> String getName();<a name="239" href="#239">239</a> <a name="240" href="#240">240</a> <em>/**<em>*</em></em><a name="241" href="#241">241</a> <em> * Returns the URI of the HTTP method</em><a name="242" href="#242">242</a> <em> * </em><a name="243" href="#243">243</a> <em> * @return The URI</em><a name="244" href="#244">244</a> <em> * </em><a name="245" href="#245">245</a> <em> * @throws URIException If the URI cannot be created.</em><a name="246" href="#246">246</a> <em> * </em><a name="247" href="#247">247</a> <em> * @see org.apache.commons.httpclient.HttpMethod#getURI()</em><a name="248" href="#248">248</a> <em> */</em><a name="249" href="#249">249</a> <strong>public</strong> URI getURI() throws URIException {<a name="250" href="#250">250</a> StringBuffer buffer = <strong>new</strong> StringBuffer();<a name="251" href="#251">251</a> <strong>if</strong> (<strong>this</strong>.httphost != <strong>null</strong>) {<a name="252" href="#252">252</a> buffer.append(<strong>this</strong>.httphost.getProtocol().getScheme());<a name="253" href="#253">253</a> buffer.append(<span class="string">"://"</span>);<a name="254" href="#254">254</a> buffer.append(<strong>this</strong>.httphost.getHostName());<a name="255" href="#255">255</a> <strong>int</strong> port = <strong>this</strong>.httphost.getPort();<a name="256" href="#256">256</a> <strong>if</strong> (port != -1 && port != <strong>this</strong>.httphost.getProtocol().getDefaultPort()) {<a name="257" href="#257">257</a> buffer.append(<span class="string">":"</span>);<a name="258" href="#258">258</a> buffer.append(port);<a name="259" href="#259">259</a> }<a name="260" href="#260">260</a> }<a name="261" href="#261">261</a> buffer.append(<strong>this</strong>.path);<a name="262" href="#262">262</a> <strong>if</strong> (<strong>this</strong>.queryString != <strong>null</strong>) {<a name="263" href="#263">263</a> buffer.append('?');<a name="264" href="#264">264</a> buffer.append(<strong>this</strong>.queryString);<a name="265" href="#265">265</a> }<a name="266" href="#266">266</a> <strong>return</strong> <strong>new</strong> URI(buffer.toString(), <strong>true</strong>);<a name="267" href="#267">267</a> }<a name="268" href="#268">268</a> <a name="269" href="#269">269</a> <em>/**<em>*</em></em><a name="270" href="#270">270</a> <em> * Sets the URI for this method. </em><a name="271" href="#271">271</a> <em> * </em><a name="272" href="#272">272</a> <em> * @param uri URI to be set </em><a name="273" href="#273">273</a> <em> * </em><a name="274" href="#274">274</a> <em> * @throws URIException if a URI cannot be set</em><a name="275" href="#275">275</a> <em> * </em><a name="276" href="#276">276</a> <em> * @since 3.0</em><a name="277" href="#277">277</a> <em> */</em><a name="278" href="#278">278</a> <strong>public</strong> <strong>void</strong> setURI(URI uri) throws URIException {<a name="279" href="#279">279</a> <em class="comment">// only set the host if specified by the URI</em><a name="280" href="#280">280</a> <strong>if</strong> (uri.isAbsoluteURI()) {<a name="281" href="#281">281</a> <strong>this</strong>.httphost = <strong>new</strong> HttpHost(uri);<a name="282" href="#282">282</a> }<a name="283" href="#283">283</a> <em class="comment">// set the path, defaulting to root</em><a name="284" href="#284">284</a> setPath(<a name="285" href="#285">285</a> uri.getPath() == <strong>null</strong><a name="286" href="#286">286</a> ? <span class="string">"/"</span><a name="287" href="#287">287</a> : uri.getEscapedPath()<a name="288" href="#288">288</a> );<a name="289" href="#289">289</a> setQueryString(uri.getEscapedQuery());<a name="290" href="#290">290</a> } <a name="291" href="#291">291</a> <a name="292" href="#292">292</a> <em>/**<em>*</em></em><a name="293" href="#293">293</a> <em> * Sets whether or not the HTTP method should automatically follow HTTP redirects </em><a name="294" href="#294">294</a> <em> * (status code 302, etc.)</em><a name="295" href="#295">295</a> <em> * </em><a name="296" href="#296">296</a> <em> * @param followRedirects <tt>true</tt> if the method will automatically follow redirects,</em><a name="297" href="#297">297</a> <em> * <tt>false</tt> otherwise.</em><a name="298" href="#298">298</a> <em> */</em><a name="299" href="#299">299</a> <strong>public</strong> <strong>void</strong> setFollowRedirects(<strong>boolean</strong> followRedirects) {<a name="300" href="#300">300</a> <strong>this</strong>.followRedirects = followRedirects;<a name="301" href="#301">301</a> }<a name="302" href="#302">302</a> <a name="303" href="#303">303</a> <em>/**<em>*</em></em><a name="304" href="#304">304</a> <em> * Returns <tt>true</tt> if the HTTP method should automatically follow HTTP redirects </em><a name="305" href="#305">305</a> <em> * (status code 302, etc.), <tt>false</tt> otherwise.</em><a name="306" href="#306">306</a> <em> * </em><a name="307" href="#307">307</a> <em> * @return <tt>true</tt> if the method will automatically follow HTTP redirects, </em><a name="308" href="#308">308</a> <em> * <tt>false</tt> otherwise.</em><a name="309" href="#309">309</a> <em> */</em><a name="310" href="#310">310</a> <strong>public</strong> <strong>boolean</strong> getFollowRedirects() {<a name="311" href="#311">311</a> <strong>return</strong> <strong>this</strong>.followRedirects;
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -