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  package org.apache.http.nio.client.util;
28  
29  import java.io.IOException;
30  
31  import org.apache.http.impl.nio.client.CloseableHttpAsyncClient;
32  
33  /**
34   * Static helpers for dealing with {@link org.apache.http.nio.client.HttpAsyncClient}.
35   */
36  public class HttpAsyncClientUtils {
37  
38      private HttpAsyncClientUtils() {
39      }
40  
41      /**
42       * Unconditionally close a httpAsyncClient. Shuts down the underlying
43       * connection manager and releases the resources.
44       * <p>
45       * Example Code:
46       *
47       * <pre>
48       * HttpAsyncClient httpAsyncClient = null;
49       * try {
50       *   httpAsyncClient = ...;
51       * } catch (Exception e) {
52       *   // error handling
53       * } finally {
54       *   HttpAsyncClientUtils.closeQuietly(httpAsyncClient);
55       * }
56       * </pre>
57       *
58       * @param httpAsyncClient
59       *            the HttpAsyncClient to close, may be null or already closed.
60       */
61      public static void closeQuietly(final CloseableHttpAsyncClient httpAsyncClient) {
62          if (httpAsyncClient != null) {
63              try {
64                  httpAsyncClient.close();
65              } catch (final IOException ignore) {
66              }
67          }
68      }
69  
70  }