View Javadoc

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.http.impl.client.cache;
29  
30  import java.io.File;
31  
32  import org.apache.http.annotation.Immutable;
33  import org.apache.http.impl.client.CloseableHttpClient;
34  
35  /**
36   * Factory methods for {@link CloseableHttpClient} instances
37   * capable of client-side caching.
38   *
39   * @since 4.3
40   */
41  @Immutable
42  public class CachingHttpClients {
43  
44      private CachingHttpClients() {
45          super();
46      }
47  
48      /**
49       * Creates builder object for construction of custom
50       * {@link CloseableHttpClient} instances.
51       */
52      public static CachingHttpClientBuilder custom() {
53          return CachingHttpClientBuilder.create();
54      }
55  
56      /**
57       * Creates {@link CloseableHttpClient} instance that uses a memory bound
58       * response cache.
59       */
60      public static CloseableHttpClient createMemoryBound() {
61          return CachingHttpClientBuilder.create().build();
62      }
63  
64      /**
65       * Creates {@link CloseableHttpClient} instance that uses a file system
66       * bound response cache.
67       *
68       * @param cacheDir location of response cache.
69       */
70      public static CloseableHttpClient createFileBound(final File cacheDir) {
71          return CachingHttpClientBuilder.create().setCacheDir(cacheDir).build();
72      }
73  
74  }