View Javadoc

1   /*
2    * ====================================================================
3    *
4    *  Licensed to the Apache Software Foundation (ASF) under one or more
5    *  contributor license agreements.  See the NOTICE file distributed with
6    *  this work for additional information regarding copyright ownership.
7    *  The ASF licenses this file to You under the Apache License, Version 2.0
8    *  (the "License"); you may not use this file except in compliance with
9    *  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, software
14   *  distributed under the License is distributed on an "AS IS" BASIS,
15   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   *  See the License for the specific language governing permissions and
17   *  limitations under the License.
18   * ====================================================================
19   *
20   * This software consists of voluntary contributions made by many
21   * individuals on behalf of the Apache Software Foundation.  For more
22   * information on the Apache Software Foundation, please see
23   * <http://www.apache.org/>.
24   *
25   */
26  
27  package org.apache.http.client;
28  
29  import java.io.IOException;
30  
31  import org.apache.http.HttpResponse;
32  
33  /**
34   * Handler that encapsulates the process of generating a response object
35   * from a {@link HttpResponse}.
36   *
37   *
38   * @since 4.0
39   */
40  public interface ResponseHandler<T> {
41  
42      /**
43       * Processes an {@link HttpResponse} and returns some value
44       * corresponding to that response.
45       *
46       * @param response The response to process
47       * @return A value determined by the response
48       *
49       * @throws ClientProtocolException in case of an http protocol error
50       * @throws IOException in case of a problem or the connection was aborted
51       */
52      T handleResponse(HttpResponse response) throws ClientProtocolException, IOException;
53  
54  }