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.hc.client5.http.impl.classic; 29 30 import java.io.IOException; 31 32 import org.apache.hc.client5.http.ClientProtocolException; 33 import org.apache.hc.core5.annotation.Contract; 34 import org.apache.hc.core5.annotation.ThreadingBehavior; 35 import org.apache.hc.core5.http.ClassicHttpResponse; 36 import org.apache.hc.core5.http.HttpEntity; 37 import org.apache.hc.core5.http.ParseException; 38 import org.apache.hc.core5.http.io.entity.EntityUtils; 39 40 /** 41 * A {@link org.apache.hc.core5.http.io.HttpClientResponseHandler} that returns 42 * the response body as a String for successful (2xx) responses. If the response 43 * code was >= 300, the response body is consumed 44 * and an {@link org.apache.hc.client5.http.HttpResponseException} is thrown. 45 * <p> 46 * If this is used with 47 * {@link org.apache.hc.client5.http.classic.HttpClient#execute( 48 * org.apache.hc.core5.http.ClassicHttpRequest, 49 * org.apache.hc.core5.http.io.HttpClientResponseHandler)}, 50 * HttpClient may handle redirects (3xx responses) internally. 51 * </p> 52 * 53 * @since 4.0 54 */ 55 @Contract(threading = ThreadingBehavior.STATELESS) 56 public class BasicHttpClientResponseHandler extends AbstractHttpClientResponseHandler<String> { 57 58 /** 59 * Returns the entity as a body as a String. 60 */ 61 @Override 62 public String handleEntity(final HttpEntity entity) throws IOException { 63 try { 64 return EntityUtils.toString(entity); 65 } catch (final ParseException ex) { 66 throw new ClientProtocolException(ex); 67 } 68 } 69 70 @Override 71 public String handleResponse(final ClassicHttpResponse response) throws IOException { 72 return super.handleResponse(response); 73 } 74 75 }