You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
945 lines
65 KiB
945 lines
65 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_80) on Wed Nov 30 19:45:05 CET 2022 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>CachingHttpClient (Apache HttpComponents Client 4.5.14 API)</title>
|
|
<meta name="date" content="2022-11-30">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="CachingHttpClient (Apache HttpComponents Client 4.5.14 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CachingHttpClient.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../org/apache/http/impl/client/cache/CachingExec.html" title="class in org.apache.http.impl.client.cache"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClientBuilder.html" title="class in org.apache.http.impl.client.cache"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../index.html?org/apache/http/impl/client/cache/CachingHttpClient.html" target="_top">Frames</a></li>
|
|
<li><a href="CachingHttpClient.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.apache.http.impl.client.cache</div>
|
|
<h2 title="Class CachingHttpClient" class="title">Class CachingHttpClient</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.apache.http.impl.client.cache.CachingHttpClient</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="block"><strong>Deprecated.</strong>
|
|
<div class="block"><i>(4.3) use <a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClientBuilder.html" title="class in org.apache.http.impl.client.cache"><code>CachingHttpClientBuilder</code></a> or <a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClients.html" title="class in org.apache.http.impl.client.cache"><code>CachingHttpClients</code></a>.</i></div>
|
|
</div>
|
|
<br>
|
|
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
@Contract(threading=SAFE_CONDITIONAL)
|
|
public class <span class="strong">CachingHttpClient</span>
|
|
extends <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
|
|
implements <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></pre>
|
|
<div class="block"><p>
|
|
The <a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html" title="class in org.apache.http.impl.client.cache"><code>CachingHttpClient</code></a> is meant to be a drop-in replacement for
|
|
a <a href="../../../../../../org/apache/http/impl/client/DefaultHttpClient.html" title="class in org.apache.http.impl.client"><code>DefaultHttpClient</code></a> that transparently adds client-side caching.
|
|
The current implementation is conditionally compliant with HTTP/1.1
|
|
(meaning all the MUST and MUST NOTs are obeyed), although quite a lot,
|
|
though not all, of the SHOULDs and SHOULD NOTs are obeyed too. Generally
|
|
speaking, you construct a <code>CachingHttpClient</code> by providing a
|
|
"backend" <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a> used for making actual network requests and
|
|
provide an <a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache"><code>HttpCacheStorage</code></a> instance to use for holding onto
|
|
cached responses. Additional configuration options can be provided by
|
|
passing in a <a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache"><code>CacheConfig</code></a>. Note that all of the usual client
|
|
related configuration you want to do vis-a-vis timeouts and connection
|
|
pools should be done on this backend client before constructing a <code>CachingHttpClient</code> from it.
|
|
</p>
|
|
|
|
<p>
|
|
Generally speaking, the <code>CachingHttpClient</code> is implemented as a
|
|
<a href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</a>
|
|
of the backend client; for any incoming request it attempts to satisfy
|
|
it from the cache, but if it can't, or if it needs to revalidate a stale
|
|
cache entry, it will use the backend client to make an actual request.
|
|
However, a proper HTTP/1.1 cache won't change the semantics of a request
|
|
and response; in particular, if you issue an unconditional request you
|
|
will get a full response (although it may be served to you from the cache,
|
|
or the cache may make a conditional request on your behalf to the origin).
|
|
This notion of "semantic transparency" means you should be able to drop
|
|
a <a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html" title="class in org.apache.http.impl.client.cache"><code>CachingHttpClient</code></a> into an existing application without breaking
|
|
anything.
|
|
</p>
|
|
|
|
<p>
|
|
Folks that would like to experiment with alternative storage backends
|
|
should look at the <a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache"><code>HttpCacheStorage</code></a> interface and the related
|
|
package documentation there. You may also be interested in the provided
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/ehcache/EhcacheHttpCacheStorage.html" title="class in org.apache.http.impl.client.cache.ehcache"><code>EhCache</code></a> and <a href="../../../../../../org/apache/http/impl/client/cache/memcached/MemcachedHttpCacheStorage.html" title="class in org.apache.http.impl.client.cache.memcached"><code>memcached</code></a> storage backends.
|
|
</p></div>
|
|
<dl><dt><span class="strong">Since:</span></dt>
|
|
<dd>4.1</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Field and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CACHE_RESPONSE_STATUS">CACHE_RESPONSE_STATUS</a></strong></code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">This is the name under which the <a href="../../../../../../org/apache/http/client/cache/CacheResponseStatus.html" title="enum in org.apache.http.client.cache"><code>CacheResponseStatus</code></a> of a request
|
|
(for example, whether it resulted in a cache hit) will be recorded if an
|
|
<code>HttpContext</code> is provided during execution.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient()">CachingHttpClient</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with default caching settings that
|
|
stores cache entries in memory and uses a vanilla <a href="../../../../../../org/apache/http/impl/client/DefaultHttpClient.html" title="class in org.apache.http.impl.client"><code>DefaultHttpClient</code></a>
|
|
for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient(org.apache.http.impl.client.cache.CacheConfig)">CachingHttpClient</a></strong>(<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options that
|
|
stores cache entries in memory and uses a vanilla <a href="../../../../../../org/apache/http/impl/client/DefaultHttpClient.html" title="class in org.apache.http.impl.client"><code>DefaultHttpClient</code></a>
|
|
for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient(org.apache.http.client.HttpClient)">CachingHttpClient</a></strong>(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with default caching settings that
|
|
stores cache entries in memory and uses the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a>
|
|
for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient(org.apache.http.client.HttpClient,%20org.apache.http.impl.client.cache.CacheConfig)">CachingHttpClient</a></strong>(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options that
|
|
stores cache entries in memory and uses the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a>
|
|
for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient(org.apache.http.client.HttpClient,%20org.apache.http.client.cache.HttpCacheStorage,%20org.apache.http.impl.client.cache.CacheConfig)">CachingHttpClient</a></strong>(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache">HttpCacheStorage</a> storage,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options
|
|
that stores cache entries in the provided storage backend and uses
|
|
the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a> for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#CachingHttpClient(org.apache.http.client.HttpClient,%20org.apache.http.client.cache.ResourceFactory,%20org.apache.http.client.cache.HttpCacheStorage,%20org.apache.http.impl.client.cache.CacheConfig)">CachingHttpClient</a></strong>(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/client/cache/ResourceFactory.html" title="interface in org.apache.http.client.cache">ResourceFactory</a> resourceFactory,
|
|
<a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache">HttpCacheStorage</a> storage,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options
|
|
that stores cache entries in the provided storage backend and uses
|
|
the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a> for backend requests.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest)">execute</a></strong>(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the default context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.protocol.HttpContext)">execute</a></strong>(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest originalRequest,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the given context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler)">execute</a></strong>(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request to the target using the default context and
|
|
processes the response using the given response handler.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">execute</a></strong>(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request to the target using the given context and
|
|
processes the response using the given response handler.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest)">execute</a></strong>(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the default context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.protocol.HttpContext)">execute</a></strong>(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the given context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler)">execute</a></strong>(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the default context and processes the
|
|
response using the given response handler.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><T> T</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">execute</a></strong>(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler,
|
|
org.apache.http.protocol.HttpContext context)</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Executes HTTP request using the given context and processes the
|
|
response using the given response handler.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#getCacheHits()">getCacheHits</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Reports the number of times that the cache successfully responded
|
|
to an <code>HttpRequest</code> without contacting the origin server.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#getCacheMisses()">getCacheMisses</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Reports the number of times that the cache contacted the origin
|
|
server because it had no appropriate response cached.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#getCacheUpdates()">getCacheUpdates</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Reports the number of times that the cache was able to satisfy
|
|
a response by revalidating an existing but stale cache entry.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../../org/apache/http/conn/ClientConnectionManager.html" title="interface in org.apache.http.conn">ClientConnectionManager</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#getConnectionManager()">getConnectionManager</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Obtains the connection manager used by this client.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>org.apache.http.params.HttpParams</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#getParams()">getParams</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Obtains the parameters for this client.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#isSharedCache()">isSharedCache</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Reports whether this <code>CachingHttpClient</code> is configured as
|
|
a shared (public) or non-shared (private) cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClient.html#supportsRangeAndContentRangeHeaders()">supportsRangeAndContentRangeHeaders</a></strong>()</code>
|
|
<div class="block"><strong>Deprecated.</strong> </div>
|
|
<div class="block">Reports whether this <code>CachingHttpClient</code> implementation
|
|
supports byte-range requests as specified by the <code>Range</code>
|
|
and <code>Content-Range</code> headers.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="CACHE_RESPONSE_STATUS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>CACHE_RESPONSE_STATUS</h4>
|
|
<pre>public static final <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CACHE_RESPONSE_STATUS</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">This is the name under which the <a href="../../../../../../org/apache/http/client/cache/CacheResponseStatus.html" title="enum in org.apache.http.client.cache"><code>CacheResponseStatus</code></a> of a request
|
|
(for example, whether it resulted in a cache hit) will be recorded if an
|
|
<code>HttpContext</code> is provided during execution.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.http.impl.client.cache.CachingHttpClient.CACHE_RESPONSE_STATUS">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="CachingHttpClient()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with default caching settings that
|
|
stores cache entries in memory and uses a vanilla <a href="../../../../../../org/apache/http/impl/client/DefaultHttpClient.html" title="class in org.apache.http.impl.client"><code>DefaultHttpClient</code></a>
|
|
for backend requests.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="CachingHttpClient(org.apache.http.impl.client.cache.CacheConfig)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient(<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options that
|
|
stores cache entries in memory and uses a vanilla <a href="../../../../../../org/apache/http/impl/client/DefaultHttpClient.html" title="class in org.apache.http.impl.client"><code>DefaultHttpClient</code></a>
|
|
for backend requests.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - cache module options</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CachingHttpClient(org.apache.http.client.HttpClient)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client)</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with default caching settings that
|
|
stores cache entries in memory and uses the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a>
|
|
for backend requests.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>client</code> - used to make origin requests</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CachingHttpClient(org.apache.http.client.HttpClient, org.apache.http.impl.client.cache.CacheConfig)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options that
|
|
stores cache entries in memory and uses the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a>
|
|
for backend requests.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - cache module options</dd><dd><code>client</code> - used to make origin requests</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CachingHttpClient(org.apache.http.client.HttpClient, org.apache.http.client.cache.ResourceFactory, org.apache.http.client.cache.HttpCacheStorage, org.apache.http.impl.client.cache.CacheConfig)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/client/cache/ResourceFactory.html" title="interface in org.apache.http.client.cache">ResourceFactory</a> resourceFactory,
|
|
<a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache">HttpCacheStorage</a> storage,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options
|
|
that stores cache entries in the provided storage backend and uses
|
|
the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a> for backend requests. However, cached
|
|
response bodies are managed using the given <a href="../../../../../../org/apache/http/client/cache/ResourceFactory.html" title="interface in org.apache.http.client.cache"><code>ResourceFactory</code></a>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>client</code> - used to make origin requests</dd><dd><code>resourceFactory</code> - how to manage cached response bodies</dd><dd><code>storage</code> - where to store cache entries</dd><dd><code>config</code> - cache module options</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="CachingHttpClient(org.apache.http.client.HttpClient, org.apache.http.client.cache.HttpCacheStorage, org.apache.http.impl.client.cache.CacheConfig)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>CachingHttpClient</h4>
|
|
<pre>public CachingHttpClient(<a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a> client,
|
|
<a href="../../../../../../org/apache/http/client/cache/HttpCacheStorage.html" title="interface in org.apache.http.client.cache">HttpCacheStorage</a> storage,
|
|
<a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html" title="class in org.apache.http.impl.client.cache">CacheConfig</a> config)</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Constructs a <code>CachingHttpClient</code> with the given caching options
|
|
that stores cache entries in the provided storage backend and uses
|
|
the given <a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client"><code>HttpClient</code></a> for backend requests.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>client</code> - used to make origin requests</dd><dd><code>storage</code> - where to store cache entries</dd><dd><code>config</code> - cache module options</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getCacheHits()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheHits</h4>
|
|
<pre>public long getCacheHits()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Reports the number of times that the cache successfully responded
|
|
to an <code>HttpRequest</code> without contacting the origin server.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of cache hits</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheMisses()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheMisses</h4>
|
|
<pre>public long getCacheMisses()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Reports the number of times that the cache contacted the origin
|
|
server because it had no appropriate response cached.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of cache misses</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheUpdates()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheUpdates</h4>
|
|
<pre>public long getCacheUpdates()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Reports the number of times that the cache was able to satisfy
|
|
a response by revalidating an existing but stale cache entry.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of cache revalidations</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.HttpHost, org.apache.http.HttpRequest)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public org.apache.http.HttpResponse execute(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the default context.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target host for the request.
|
|
Implementations may accept <code>null</code>
|
|
if they can still determine a route, for example
|
|
to a default target or by inspecting the request.</dd><dd><code>request</code> - the request to execute</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response to the request. This is always a final response,
|
|
never an intermediate response with an 1xx status code.
|
|
Whether redirects or authentication challenges will be returned
|
|
or handled automatically depends on the implementation and
|
|
configuration of this client.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.HttpHost, org.apache.http.HttpRequest, org.apache.http.client.ResponseHandler)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public <T> T execute(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request to the target using the default context and
|
|
processes the response using the given response handler.
|
|
<p>
|
|
Implementing classes are required to ensure that the content entity
|
|
associated with the response is fully consumed and the underlying
|
|
connection is released back to the connection manager automatically
|
|
in all cases relieving individual <a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><code>ResponseHandler</code></a>s from
|
|
having to manage resource deallocation internally.
|
|
</p></div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target host for the request.
|
|
Implementations may accept <code>null</code>
|
|
if they can still determine a route, for example
|
|
to a default target or by inspecting the request.</dd><dd><code>request</code> - the request to execute</dd><dd><code>responseHandler</code> - the response handler</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response object as generated by the response handler.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.HttpHost, org.apache.http.HttpRequest, org.apache.http.client.ResponseHandler, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public <T> T execute(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request to the target using the given context and
|
|
processes the response using the given response handler.
|
|
<p>
|
|
Implementing classes are required to ensure that the content entity
|
|
associated with the response is fully consumed and the underlying
|
|
connection is released back to the connection manager automatically
|
|
in all cases relieving individual <a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><code>ResponseHandler</code></a>s from
|
|
having to manage resource deallocation internally.
|
|
</p></div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target host for the request.
|
|
Implementations may accept <code>null</code>
|
|
if they can still determine a route, for example
|
|
to a default target or by inspecting the request.</dd><dd><code>request</code> - the request to execute</dd><dd><code>responseHandler</code> - the response handler</dd><dd><code>context</code> - the context to use for the execution, or
|
|
<code>null</code> to use the default context</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response object as generated by the response handler.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.client.methods.HttpUriRequest)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public org.apache.http.HttpResponse execute(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the default context.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request to execute</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response to the request. This is always a final response,
|
|
never an intermediate response with an 1xx status code.
|
|
Whether redirects or authentication challenges will be returned
|
|
or handled automatically depends on the implementation and
|
|
configuration of this client.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.client.methods.HttpUriRequest, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public org.apache.http.HttpResponse execute(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.protocol.HttpContext)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the given context.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.protocol.HttpContext)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request to execute</dd><dd><code>context</code> - the context to use for the execution, or
|
|
<code>null</code> to use the default context</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response to the request. This is always a final response,
|
|
never an intermediate response with an 1xx status code.
|
|
Whether redirects or authentication challenges will be returned
|
|
or handled automatically depends on the implementation and
|
|
configuration of this client.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public <T> T execute(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the default context and processes the
|
|
response using the given response handler.
|
|
<p>
|
|
Implementing classes are required to ensure that the content entity
|
|
associated with the response is fully consumed and the underlying
|
|
connection is released back to the connection manager automatically
|
|
in all cases relieving individual <a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><code>ResponseHandler</code></a>s from
|
|
having to manage resource deallocation internally.
|
|
</p></div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request to execute</dd><dd><code>responseHandler</code> - the response handler</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response object as generated by the response handler.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public <T> T execute(<a href="../../../../../../org/apache/http/client/methods/HttpUriRequest.html" title="interface in org.apache.http.client.methods">HttpUriRequest</a> request,
|
|
<a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client">ResponseHandler</a><? extends T> responseHandler,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the given context and processes the
|
|
response using the given response handler.
|
|
<p>
|
|
Implementing classes are required to ensure that the content entity
|
|
associated with the response is fully consumed and the underlying
|
|
connection is released back to the connection manager automatically
|
|
in all cases relieving individual <a href="../../../../../../org/apache/http/client/ResponseHandler.html" title="interface in org.apache.http.client"><code>ResponseHandler</code></a>s from
|
|
having to manage resource deallocation internally.
|
|
</p></div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.client.methods.HttpUriRequest,%20org.apache.http.client.ResponseHandler,%20org.apache.http.protocol.HttpContext)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the request to execute</dd><dd><code>responseHandler</code> - the response handler</dd><dd><code>context</code> - the context to use for the execution, or
|
|
<code>null</code> to use the default context</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response object as generated by the response handler.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getConnectionManager()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getConnectionManager</h4>
|
|
<pre>public <a href="../../../../../../org/apache/http/conn/ClientConnectionManager.html" title="interface in org.apache.http.conn">ClientConnectionManager</a> getConnectionManager()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#getConnectionManager()">HttpClient</a></code></strong></div>
|
|
<div class="block">Obtains the connection manager used by this client.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#getConnectionManager()">getConnectionManager</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the connection manager</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getParams()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getParams</h4>
|
|
<pre>public org.apache.http.params.HttpParams getParams()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#getParams()">HttpClient</a></code></strong></div>
|
|
<div class="block">Obtains the parameters for this client.
|
|
These parameters will become defaults for all requests being
|
|
executed with this client, and for the parameters of
|
|
dependent objects in this client.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#getParams()">getParams</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the default parameters</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="execute(org.apache.http.HttpHost, org.apache.http.HttpRequest, org.apache.http.protocol.HttpContext)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>execute</h4>
|
|
<pre>public org.apache.http.HttpResponse execute(org.apache.http.HttpHost target,
|
|
org.apache.http.HttpRequest originalRequest,
|
|
org.apache.http.protocol.HttpContext context)
|
|
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.protocol.HttpContext)">HttpClient</a></code></strong></div>
|
|
<div class="block">Executes HTTP request using the given context.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/HttpClient.html#execute(org.apache.http.HttpHost,%20org.apache.http.HttpRequest,%20org.apache.http.protocol.HttpContext)">execute</a></code> in interface <code><a href="../../../../../../org/apache/http/client/HttpClient.html" title="interface in org.apache.http.client">HttpClient</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target host for the request.
|
|
Implementations may accept <code>null</code>
|
|
if they can still determine a route, for example
|
|
to a default target or by inspecting the request.</dd><dd><code>originalRequest</code> - the request to execute</dd><dd><code>context</code> - the context to use for the execution, or
|
|
<code>null</code> to use the default context</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the response to the request. This is always a final response,
|
|
never an intermediate response with an 1xx status code.
|
|
Whether redirects or authentication challenges will be returned
|
|
or handled automatically depends on the implementation and
|
|
configuration of this client.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case of a problem or the connection was aborted</dd>
|
|
<dd><code><a href="../../../../../../org/apache/http/client/ClientProtocolException.html" title="class in org.apache.http.client">ClientProtocolException</a></code> - in case of an http protocol error</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="supportsRangeAndContentRangeHeaders()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>supportsRangeAndContentRangeHeaders</h4>
|
|
<pre>public boolean supportsRangeAndContentRangeHeaders()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Reports whether this <code>CachingHttpClient</code> implementation
|
|
supports byte-range requests as specified by the <code>Range</code>
|
|
and <code>Content-Range</code> headers.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if byte-range requests are supported</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isSharedCache()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>isSharedCache</h4>
|
|
<pre>public boolean isSharedCache()</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
|
<div class="block">Reports whether this <code>CachingHttpClient</code> is configured as
|
|
a shared (public) or non-shared (private) cache. See <a href="../../../../../../org/apache/http/impl/client/cache/CacheConfig.html#setSharedCache(boolean)"><code>CacheConfig.setSharedCache(boolean)</code></a>.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if we are behaving as a shared (public)
|
|
cache</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CachingHttpClient.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../org/apache/http/impl/client/cache/CachingExec.html" title="class in org.apache.http.impl.client.cache"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../../org/apache/http/impl/client/cache/CachingHttpClientBuilder.html" title="class in org.apache.http.impl.client.cache"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../../index.html?org/apache/http/impl/client/cache/CachingHttpClient.html" target="_top">Frames</a></li>
|
|
<li><a href="CachingHttpClient.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright © 1999–2022 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|