1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.client5.http.impl.cache;
29
30 import java.io.File;
31
32 import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient;
33
34 /**
35 * Factory methods for {@link CloseableHttpAsyncClient} instances
36 * capable of client-side caching.
37 *
38 * @since 5.0
39 */
40 public final class CachingHttpAsyncClients {
41
42 private CachingHttpAsyncClients() {
43 super();
44 }
45
46 /**
47 * Creates builder object for construction of custom
48 * {@link CloseableHttpAsyncClient} instances.
49 */
50 public static CachingHttpAsyncClientBuilder custom() {
51 return CachingHttpAsyncClientBuilder.create();
52 }
53
54 /**
55 * Creates {@link CloseableHttpAsyncClient} instance that uses a memory bound
56 * response cache.
57 */
58 public static CloseableHttpAsyncClient createMemoryBound() {
59 return CachingHttpAsyncClientBuilder.create().build();
60 }
61
62 /**
63 * Creates {@link CloseableHttpAsyncClient} instance that uses a file system
64 * bound response cache.
65 *
66 * @param cacheDir location of response cache.
67 */
68 public static CloseableHttpAsyncClient createFileBound(final File cacheDir) {
69 return CachingHttpAsyncClientBuilder.create().setCacheDir(cacheDir).build();
70 }
71
72 /**
73 * Creates builder object for construction of custom HTTP/2
74 * {@link CloseableHttpAsyncClient} instances.
75 */
76 public static CachingH2AsyncClientBuilder customHttp2() {
77 return CachingH2AsyncClientBuilder.create();
78 }
79
80 /**
81 * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a memory bound
82 * response cache.
83 */
84 public static CloseableHttpAsyncClient createHttp2MemoryBound() {
85 return CachingH2AsyncClientBuilder.create().build();
86 }
87
88 /**
89 * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a file system
90 * bound response cache.
91 *
92 * @param cacheDir location of response cache.
93 */
94 public static CloseableHttpAsyncClient createHttp2FileBound(final File cacheDir) {
95 return CachingH2AsyncClientBuilder.create().setCacheDir(cacheDir).build();
96 }
97
98 }