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.annotation.Immutable;
33
34 import org.apache.http.HttpEntity;
35 import org.apache.http.HttpResponse;
36 import org.apache.http.StatusLine;
37 import org.apache.http.client.ResponseHandler;
38 import org.apache.http.client.HttpResponseException;
39 import org.apache.http.util.EntityUtils;
40
41 /**
42 * A {@link ResponseHandler} that returns the response body as a String
43 * for successful (2xx) responses. If the response code was >= 300, the response
44 * body is consumed and an {@link HttpResponseException} is thrown.
45 * <p/>
46 * If this is used with
47 * {@link org.apache.http.client.HttpClient#execute(
48 * org.apache.http.client.methods.HttpUriRequest, ResponseHandler)},
49 * HttpClient may handle redirects (3xx responses) internally.
50 *
51 * @since 4.0
52 */
53 @Immutable
54 public class BasicResponseHandler implements ResponseHandler<String> {
55
56 /**
57 * Returns the response body as a String if the response was successful (a
58 * 2xx status code). If no response body exists, this returns null. If the
59 * response was unsuccessful (>= 300 status code), throws an
60 * {@link HttpResponseException}.
61 */
62 public String handleResponse(final HttpResponse response)
63 throws HttpResponseException, IOException {
64 StatusLine statusLine = response.getStatusLine();
65 HttpEntity entity = response.getEntity();
66 if (statusLine.getStatusCode() >= 300) {
67 EntityUtils.consume(entity);
68 throw new HttpResponseException(statusLine.getStatusCode(),
69 statusLine.getReasonPhrase());
70 }
71 return entity == null ? null : EntityUtils.toString(entity);
72 }
73
74 }