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;
29  
30  import java.io.IOException;
31  
32  import org.apache.http.HttpEntity;
33  import org.apache.http.HttpResponse;
34  import org.apache.http.annotation.Immutable;
35  import org.apache.http.client.HttpResponseException;
36  import org.apache.http.util.EntityUtils;
37  
38  /**
39   * A {@link org.apache.http.client.ResponseHandler} that returns the response body as a String
40   * for successful (2xx) responses. If the response code was &gt;= 300, the response
41   * body is consumed and an {@link org.apache.http.client.HttpResponseException} is thrown.
42   * <p>
43   * If this is used with
44   * {@link org.apache.http.client.HttpClient#execute(
45   *  org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler)},
46   * HttpClient may handle redirects (3xx responses) internally.
47   * </p>
48   *
49   * @since 4.0
50   */
51  @Immutable
52  public class BasicResponseHandler extends AbstractResponseHandler<String> {
53  
54      /**
55       * Returns the entity as a body as a String.
56       */
57      @Override
58      public String handleEntity(final HttpEntity entity) throws IOException {
59          return EntityUtils.toString(entity);
60      }
61  
62      @Override
63      public String handleResponse(
64              final HttpResponse response) throws HttpResponseException, IOException {
65          return super.handleResponse(response);
66      }
67  
68  }