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