You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2017/11/14 20:19:47 UTC
httpcomponents-client git commit: Builder for caching HTTP/2
HttpAsyncClient
Repository: httpcomponents-client
Updated Branches:
refs/heads/master e3cd57a57 -> 5da1bd8f8
Builder for caching HTTP/2 HttpAsyncClient
Project: http://git-wip-us.apache.org/repos/asf/httpcomponents-client/repo
Commit: http://git-wip-us.apache.org/repos/asf/httpcomponents-client/commit/5da1bd8f
Tree: http://git-wip-us.apache.org/repos/asf/httpcomponents-client/tree/5da1bd8f
Diff: http://git-wip-us.apache.org/repos/asf/httpcomponents-client/diff/5da1bd8f
Branch: refs/heads/master
Commit: 5da1bd8f8dbe642e9881af77727fc381299a81bb
Parents: e3cd57a
Author: Oleg Kalnichevski <ol...@apache.org>
Authored: Tue Nov 14 21:17:44 2017 +0100
Committer: Oleg Kalnichevski <ol...@apache.org>
Committed: Tue Nov 14 21:17:44 2017 +0100
----------------------------------------------------------------------
.../cache/CachingHttp2AsyncClientBuilder.java | 144 +++++++++++++++++++
.../impl/cache/CachingHttpAsyncClients.java | 26 ++++
2 files changed, 170 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/httpcomponents-client/blob/5da1bd8f/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttp2AsyncClientBuilder.java
----------------------------------------------------------------------
diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttp2AsyncClientBuilder.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttp2AsyncClientBuilder.java
new file mode 100644
index 0000000..b2e6d0d
--- /dev/null
+++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttp2AsyncClientBuilder.java
@@ -0,0 +1,144 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+package org.apache.hc.client5.http.impl.cache;
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+
+import org.apache.hc.client5.http.async.AsyncExecChainHandler;
+import org.apache.hc.client5.http.cache.HttpCacheInvalidator;
+import org.apache.hc.client5.http.cache.HttpCacheStorage;
+import org.apache.hc.client5.http.cache.ResourceFactory;
+import org.apache.hc.client5.http.impl.ChainElements;
+import org.apache.hc.client5.http.impl.async.Http2AsyncClientBuilder;
+import org.apache.hc.core5.http.config.NamedElementChain;
+
+/**
+ * Builder for HTTP/2 {@link org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient}
+ * instances capable of client-side caching.
+ *
+ * @since 5.0
+ */
+public class CachingHttp2AsyncClientBuilder extends Http2AsyncClientBuilder {
+
+ private ResourceFactory resourceFactory;
+ private HttpCacheStorage storage;
+ private File cacheDir;
+ private CacheConfig cacheConfig;
+ private HttpCacheInvalidator httpCacheInvalidator;
+ private boolean deleteCache;
+
+ public static CachingHttp2AsyncClientBuilder create() {
+ return new CachingHttp2AsyncClientBuilder();
+ }
+
+ protected CachingHttp2AsyncClientBuilder() {
+ super();
+ this.deleteCache = true;
+ }
+
+ public final CachingHttp2AsyncClientBuilder setResourceFactory(
+ final ResourceFactory resourceFactory) {
+ this.resourceFactory = resourceFactory;
+ return this;
+ }
+
+ public final CachingHttp2AsyncClientBuilder setHttpCacheStorage(
+ final HttpCacheStorage storage) {
+ this.storage = storage;
+ return this;
+ }
+
+ public final CachingHttp2AsyncClientBuilder setCacheDir(
+ final File cacheDir) {
+ this.cacheDir = cacheDir;
+ return this;
+ }
+
+ public final CachingHttp2AsyncClientBuilder setCacheConfig(
+ final CacheConfig cacheConfig) {
+ this.cacheConfig = cacheConfig;
+ return this;
+ }
+
+ public final CachingHttp2AsyncClientBuilder setHttpCacheInvalidator(
+ final HttpCacheInvalidator cacheInvalidator) {
+ this.httpCacheInvalidator = cacheInvalidator;
+ return this;
+ }
+
+ public CachingHttp2AsyncClientBuilder setDeleteCache(final boolean deleteCache) {
+ this.deleteCache = deleteCache;
+ return this;
+ }
+
+ @Override
+ protected void customizeExecChain(final NamedElementChain<AsyncExecChainHandler> execChainDefinition) {
+ final CacheConfig config = this.cacheConfig != null ? this.cacheConfig : CacheConfig.DEFAULT;
+ // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version
+ ResourceFactory resourceFactoryCopy = this.resourceFactory;
+ if (resourceFactoryCopy == null) {
+ if (this.cacheDir == null) {
+ resourceFactoryCopy = new HeapResourceFactory();
+ } else {
+ resourceFactoryCopy = new FileResourceFactory(cacheDir);
+ }
+ }
+ HttpCacheStorage storageCopy = this.storage;
+ if (storageCopy == null) {
+ if (this.cacheDir == null) {
+ storageCopy = new BasicHttpCacheStorage(config);
+ } else {
+ final ManagedHttpCacheStorage managedStorage = new ManagedHttpCacheStorage(config);
+ if (this.deleteCache) {
+ addCloseable(new Closeable() {
+
+ @Override
+ public void close() throws IOException {
+ managedStorage.shutdown();
+ }
+
+ });
+ } else {
+ addCloseable(managedStorage);
+ }
+ storageCopy = managedStorage;
+ }
+ }
+ final CacheKeyGenerator uriExtractor = new CacheKeyGenerator();
+ final HttpCache httpCache = new BasicHttpCache(
+ resourceFactoryCopy,
+ storageCopy,
+ uriExtractor,
+ this.httpCacheInvalidator != null ? this.httpCacheInvalidator : new DefaultCacheInvalidator(uriExtractor, storageCopy));
+
+ final AsyncCachingExec cachingExec = new AsyncCachingExec(httpCache, config);
+ execChainDefinition.addBefore(ChainElements.PROTOCOL.name(), cachingExec, ChainElements.CACHING.name());
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/httpcomponents-client/blob/5da1bd8f/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java
----------------------------------------------------------------------
diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java
index 7356b81..230791b 100644
--- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java
+++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java
@@ -72,4 +72,30 @@ public class CachingHttpAsyncClients {
return CachingHttpAsyncClientBuilder.create().setCacheDir(cacheDir).build();
}
+ /**
+ * Creates builder object for construction of custom HTTP/2
+ * {@link CloseableHttpAsyncClient} instances.
+ */
+ public static CachingHttp2AsyncClientBuilder customHttp2() {
+ return CachingHttp2AsyncClientBuilder.create();
+ }
+
+ /**
+ * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a memory bound
+ * response cache.
+ */
+ public static CloseableHttpAsyncClient createHttp2MemoryBound() {
+ return CachingHttp2AsyncClientBuilder.create().build();
+ }
+
+ /**
+ * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a file system
+ * bound response cache.
+ *
+ * @param cacheDir location of response cache.
+ */
+ public static CloseableHttpAsyncClient createHttp2FileBound(final File cacheDir) {
+ return CachingHttp2AsyncClientBuilder.create().setCacheDir(cacheDir).build();
+ }
+
}