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.hc.core5.http.io;
28  
29  import java.io.IOException;
30  
31  import org.apache.hc.core5.http.ClassicHttpResponse;
32  import org.apache.hc.core5.http.HttpException;
33  
34  /**
35   * Handler that encapsulates the process of generating a response object
36   * from a {@link ClassicHttpResponse}.
37   *
38   *
39   * @since 4.0
40   */
41  public interface HttpClientResponseHandler<T> {
42  
43      /**
44       * Processes an {@link ClassicHttpResponse} and returns some value
45       * corresponding to that response.
46       *
47       * @param response The response to process
48       * @return A value determined by the response
49       *
50       * @throws IOException in case of a problem or the connection was aborted
51       */
52      T handleResponse(ClassicHttpResponse response) throws HttpException, IOException;
53  
54  }