Return-Path: Delivered-To: apmail-hc-commits-archive@www.apache.org Received: (qmail 5099 invoked from network); 7 Jan 2011 21:01:37 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 7 Jan 2011 21:01:37 -0000 Received: (qmail 54772 invoked by uid 500); 7 Jan 2011 21:01:37 -0000 Delivered-To: apmail-hc-commits-archive@hc.apache.org Received: (qmail 54728 invoked by uid 500); 7 Jan 2011 21:01:37 -0000 Mailing-List: contact commits-help@hc.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "HttpComponents Project" Delivered-To: mailing list commits@hc.apache.org Received: (qmail 54721 invoked by uid 99); 7 Jan 2011 21:01:37 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 07 Jan 2011 21:01:37 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 07 Jan 2011 21:01:36 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 877882388A5E; Fri, 7 Jan 2011 21:01:16 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1056504 - /httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html Date: Fri, 07 Jan 2011 21:01:16 -0000 To: commits@hc.apache.org From: jonm@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110107210116.877882388A5E@eris.apache.org> Author: jonm Date: Fri Jan 7 21:01:16 2011 New Revision: 1056504 URL: http://svn.apache.org/viewvc?rev=1056504&view=rev Log: Added Javadoc package.html for org.apache.http.client.cache. Added: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html (with props) Added: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html?rev=1056504&view=auto ============================================================================== --- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html (added) +++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html Fri Jan 7 21:01:16 2011 @@ -0,0 +1,78 @@ + + + + + + + +

+This package consists largely of constants and interfaces that are +necessary for building new storage backends for the +{@link org.apache.http.impl.client.cache.CachingHttpClient} or for +those clients wanting to get a little more behavioral information +out of the cache module (for example, whether a particular response +was a cache hit or not). Developers that simply want to instantiate +and make use of the caching module will be better off looking at +the {@code CachingHttpClient} documentation itself. +

+The classes in this package can be divided into two main groups: +reference constants and interfaces needed for storage backends. In +the former group, +{@link org.apache.http.client.cache.HeaderConstants} contains a list +of HTTP header names encoded as static fields, and the +{@link org.apache.http.client.cache.CacheResponseStatus} enumeration +values are set in an {@link org.apache.http.protocol.HttpContext} by +the {@code CachingHttpClient} to indicate how the request was +processed by the caching module itself. +

+New storage backends will need to implement the +{@link org.apache.http.client.cache.HttpCacheStorage} +interface; they can then be passed to one of the {@code CachingHttpClient} +constructors, which will happily make use of the new storage mechanism. +The {@link org.apache.http.client.cache.HttpCacheEntry} class shows the +datastructure for a cache entry that must be stored by the +{@code HttpCacheStorage}. +There is, in addition, the notion of a +{@link org.apache.http.client.cache.Resource} and an associated +{@link org.apache.http.client.cache.ResourceFactory}, which are used for +managing the handling of cached response bodies. The default implementation +used by the {@code CachingHttpClient} stores response bodies in memory; +alternative implementations might involve storing these in a filesystem. A new +{@code ResourceFactory} can be provided along with a {@code HttpCacheStorage} +in one of the constructors to the {@code CachingHttpClient}. Finally, some +of the additional storage backends we provide, like the +{@link org.apache.http.impl.client.cache.ehcache.EhcacheHttpCacheStorage} and +{@link org.apache.http.impl.client.cache.memcached.MemcachedHttpCacheStorage}, +can be provided with different serializers for the cache entry metadata; +developers wanting to experiment with different serialization techniques +should implement the +{@link org.apache.http.client.cache.HttpCacheEntrySerializer} interface. +

+ + Propchange: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html ------------------------------------------------------------------------------ svn:keywords = Date Author Id Revision HeadURL Propchange: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/package.html ------------------------------------------------------------------------------ svn:mime-type = text/html