📄 httpconnection.html
字号:
<a name="314" href="#314">314</a> <a name="315" href="#315">315</a> <em>/**<em>*</em></em><a name="316" href="#316">316</a> <em> * Returns the proxy host.</em><a name="317" href="#317">317</a> <em> *</em><a name="318" href="#318">318</a> <em> * @return the proxy host.</em><a name="319" href="#319">319</a> <em> */</em><a name="320" href="#320">320</a> <strong>public</strong> String getProxyHost() {<a name="321" href="#321">321</a> <strong>return</strong> proxyHostName;<a name="322" href="#322">322</a> }<a name="323" href="#323">323</a> <a name="324" href="#324">324</a> <em>/**<em>*</em></em><a name="325" href="#325">325</a> <em> * Sets the host to proxy through.</em><a name="326" href="#326">326</a> <em> *</em><a name="327" href="#327">327</a> <em> * @param host the host to proxy through.</em><a name="328" href="#328">328</a> <em> * </em><a name="329" href="#329">329</a> <em> * @throws IllegalStateException if the connection is already open</em><a name="330" href="#330">330</a> <em> */</em><a name="331" href="#331">331</a> <strong>public</strong> <strong>void</strong> setProxyHost(String host) throws IllegalStateException {<a name="332" href="#332">332</a> assertNotOpen();<a name="333" href="#333">333</a> proxyHostName = host;<a name="334" href="#334">334</a> }<a name="335" href="#335">335</a> <a name="336" href="#336">336</a> <em>/**<em>*</em></em><a name="337" href="#337">337</a> <em> * Returns the port of the proxy host.</em><a name="338" href="#338">338</a> <em> *</em><a name="339" href="#339">339</a> <em> * @return the proxy port.</em><a name="340" href="#340">340</a> <em> */</em><a name="341" href="#341">341</a> <strong>public</strong> <strong>int</strong> getProxyPort() {<a name="342" href="#342">342</a> <strong>return</strong> proxyPortNumber;<a name="343" href="#343">343</a> }<a name="344" href="#344">344</a> <a name="345" href="#345">345</a> <em>/**<em>*</em></em><a name="346" href="#346">346</a> <em> * Sets the port of the host to proxy through.</em><a name="347" href="#347">347</a> <em> *</em><a name="348" href="#348">348</a> <em> * @param port the port of the host to proxy through.</em><a name="349" href="#349">349</a> <em> * </em><a name="350" href="#350">350</a> <em> * @throws IllegalStateException if the connection is already open</em><a name="351" href="#351">351</a> <em> */</em><a name="352" href="#352">352</a> <strong>public</strong> <strong>void</strong> setProxyPort(<strong>int</strong> port) throws IllegalStateException {<a name="353" href="#353">353</a> assertNotOpen();<a name="354" href="#354">354</a> proxyPortNumber = port;<a name="355" href="#355">355</a> }<a name="356" href="#356">356</a> <a name="357" href="#357">357</a> <em>/**<em>*</em></em><a name="358" href="#358">358</a> <em> * Returns <tt>true</tt> if the connection is established over </em><a name="359" href="#359">359</a> <em> * a secure protocol.</em><a name="360" href="#360">360</a> <em> *</em><a name="361" href="#361">361</a> <em> * @return <tt>true</tt> if connected over a secure protocol.</em><a name="362" href="#362">362</a> <em> */</em><a name="363" href="#363">363</a> <strong>public</strong> <strong>boolean</strong> isSecure() {<a name="364" href="#364">364</a> <strong>return</strong> protocolInUse.isSecure();<a name="365" href="#365">365</a> }<a name="366" href="#366">366</a> <a name="367" href="#367">367</a> <em>/**<em>*</em></em><a name="368" href="#368">368</a> <em> * Returns the protocol used to establish the connection.</em><a name="369" href="#369">369</a> <em> * @return The protocol</em><a name="370" href="#370">370</a> <em> */</em><a name="371" href="#371">371</a> <strong>public</strong> Protocol getProtocol() {<a name="372" href="#372">372</a> <strong>return</strong> protocolInUse;<a name="373" href="#373">373</a> }<a name="374" href="#374">374</a> <a name="375" href="#375">375</a> <em>/**<em>*</em></em><a name="376" href="#376">376</a> <em> * Sets the protocol used to establish the connection</em><a name="377" href="#377">377</a> <em> * </em><a name="378" href="#378">378</a> <em> * @param protocol The protocol to use.</em><a name="379" href="#379">379</a> <em> * </em><a name="380" href="#380">380</a> <em> * @throws IllegalStateException if the connection is already open</em><a name="381" href="#381">381</a> <em> */</em><a name="382" href="#382">382</a> <strong>public</strong> <strong>void</strong> setProtocol(Protocol protocol) {<a name="383" href="#383">383</a> assertNotOpen();<a name="384" href="#384">384</a> <a name="385" href="#385">385</a> <strong>if</strong> (protocol == <strong>null</strong>) {<a name="386" href="#386">386</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"protocol is null"</span>);<a name="387" href="#387">387</a> }<a name="388" href="#388">388</a> <a name="389" href="#389">389</a> protocolInUse = protocol;<a name="390" href="#390">390</a> <a name="391" href="#391">391</a> }<a name="392" href="#392">392</a> <a name="393" href="#393">393</a> <em>/**<em>*</em></em><a name="394" href="#394">394</a> <em> * Return the local address used when creating the connection.</em><a name="395" href="#395">395</a> <em> * If <tt>null</tt>, the default address is used.</em><a name="396" href="#396">396</a> <em> * </em><a name="397" href="#397">397</a> <em> * @return InetAddress the local address to be used when creating Sockets</em><a name="398" href="#398">398</a> <em> */</em><a name="399" href="#399">399</a> <strong>public</strong> InetAddress getLocalAddress() {<a name="400" href="#400">400</a> <strong>return</strong> <strong>this</strong>.localAddress;<a name="401" href="#401">401</a> }<a name="402" href="#402">402</a> <a name="403" href="#403">403</a> <em>/**<em>*</em></em><a name="404" href="#404">404</a> <em> * Set the local address used when creating the connection.</em><a name="405" href="#405">405</a> <em> * If unset or <tt>null</tt>, the default address is used.</em><a name="406" href="#406">406</a> <em> * </em><a name="407" href="#407">407</a> <em> * @param localAddress the local address to use</em><a name="408" href="#408">408</a> <em> */</em><a name="409" href="#409">409</a> <strong>public</strong> <strong>void</strong> setLocalAddress(InetAddress localAddress) {<a name="410" href="#410">410</a> assertNotOpen();<a name="411" href="#411">411</a> <strong>this</strong>.localAddress = localAddress;<a name="412" href="#412">412</a> }<a name="413" href="#413">413</a> <a name="414" href="#414">414</a> <em>/**<em>*</em></em><a name="415" href="#415">415</a> <em> * Tests if the connection is open. </em><a name="416" href="#416">416</a> <em> *</em><a name="417" href="#417">417</a> <em> * @return <code>true</code> if the connection is open</em><a name="418" href="#418">418</a> <em> */</em><a name="419" href="#419">419</a> <strong>public</strong> <strong>boolean</strong> isOpen() {<a name="420" href="#420">420</a> <strong>return</strong> isOpen;<a name="421" href="#421">421</a> }<a name="422" href="#422">422</a> <a name="423" href="#423">423</a> <em>/**<em>*</em></em><a name="424" href="#424">424</a> <em> * Closes the connection if stale.</em><a name="425" href="#425">425</a> <em> * </em><a name="426" href="#426">426</a> <em> * @return <code>true</code> if the connection was stale and therefore closed, </em><a name="427" href="#427">427</a> <em> * <code>false</code> otherwise.</em><a name="428" href="#428">428</a> <em> * </em><a name="429" href="#429">429</a> <em> * @see #isStale()</em><a name="430" href="#430">430</a> <em> * </em><a name="431" href="#431">431</a> <em> * @since 3.0</em><a name="432" href="#432">432</a> <em> */</em><a name="433" href="#433">433</a> <strong>public</strong> <strong>boolean</strong> closeIfStale() throws IOException {<a name="434" href="#434">434</a> <strong>if</strong> (isOpen && isStale()) {<a name="435" href="#435">435</a> LOG.debug(<span class="string">"Connection is stale, closing..."</span>);<a name="436" href="#436">436</a> close();<a name="437" href="#437">437</a> <strong>return</strong> <strong>true</strong>;<a name="438" href="#438">438</a> }<a name="439" href="#439">439</a> <strong>return</strong> false;<a name="440" href="#440">440</a> }<a name="441" href="#441">441</a> <a name="442" href="#442">442</a> <em>/**<em>*</em></em><a name="443" href="#443">443</a> <em> * Tests if stale checking is enabled.</em><a name="444" href="#444">444</a> <em> * </em><a name="445" href="#445">445</a> <em> * @return <code>true</code> if enabled</em><a name="446" href="#446">446</a> <em> * </em><a name="447" href="#447">447</a> <em> * @see #isStale()</em><a name="448" href="#448">448</a> <em> * </em><a name="449" href="#449">449</a> <em> * @deprecated Use {@link HttpConnectionParams#isStaleCheckingEnabled()},</em><a name="450" href="#450">450</a> <em> * {@link HttpConnection#getParams()}.</em><a name="451" href="#451">451</a> <em> */</em><a name="452" href="#452">452</a> <strong>public</strong> <strong>boolean</strong> isStaleCheckingEnabled() {<a name="453" href="#453">453</a> <strong>return</strong> <strong>this</strong>.params.isStaleCheckingEnabled();<a name="454" href="#454">454</a> }<a name="455" href="#455">455</a> <a name="456" href="#456">456</a> <em>/**<em>*</em></em><a name="457" href="#457">457</a> <em> * Sets whether or not isStale() will be called when testing if this connection is open.</em><a name="458" href="#458">458</a> <em> * </em><a name="459" href="#459">459</a> <em> * <p>Setting this flag to <code>false</code> will increase performance when reusing</em><a name="460" href="#460">460</a> <em> * connections, but it will also make them less reliable. Stale checking ensures that</em><a name="461" href="#461">461</a> <em> * connections are viable before they are used. When set to <code>false</code> some</em><a name="462" href="#462">462</a> <em> * method executions will result in IOExceptions and they will have to be retried.</p></em><a name="463" href="#463">463</a> <em> * </em><a name="464" href="#464">464</a> <em> * @param staleCheckEnabled <code>true</code> to enable isStale()</em><a name="465" href="#465">465</a> <em> * </em><a name="466" href="#466">466</a> <em> * @see #isStale()</em><a name="467" href="#467">467</a> <em> * @see #isOpen()</em><a name="468" href="#468">468</a> <em> * </em><a name="469" href="#469">469</a> <em> * @deprecated Use {@link HttpConnectionParams#setStaleCheckingEnabled(boolean)},</em><a name="470" href="#470">470</a> <em> * {@link HttpConnection#getParams()}.</em><a name="471" href="#471">471</a> <em> */</em><a name="472" href="#472">472</a> <strong>public</strong> <strong>void</strong> setStaleCheckingEnabled(<strong>boolean</strong> staleCheckEnabled) {<a name="473" href="#473">473</a> <strong>this</strong>.params.setStaleCheckingEnabled(staleCheckEnabled);<a name="474" href="#474">474</a> }
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -