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