/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.http.impl.client;

import java.io.IOException;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.annotation.Contract;
import org.apache.http.annotation.ThreadingBehavior;
import org.apache.http.client.HttpResponseException;
import org.apache.http.util.EntityUtils;

A ResponseHandler that returns the response body as a String for successful (2xx) responses. If the response code was >= 300, the response body is consumed and an HttpResponseException is thrown.

If this is used with HttpClient.execute(HttpUriRequest, ResponseHandler<? extends Object>), HttpClient may handle redirects (3xx responses) internally.

Since:4.0
/** * A {@link org.apache.http.client.ResponseHandler} that returns the response body as a String * for successful (2xx) responses. If the response code was &gt;= 300, the response * body is consumed and an {@link org.apache.http.client.HttpResponseException} is thrown. * <p> * If this is used with * {@link org.apache.http.client.HttpClient#execute( * org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler)}, * HttpClient may handle redirects (3xx responses) internally. * </p> * * @since 4.0 */
@Contract(threading = ThreadingBehavior.IMMUTABLE) public class BasicResponseHandler extends AbstractResponseHandler<String> {
Returns the entity as a body as a String.
/** * Returns the entity as a body as a String. */
@Override public String handleEntity(final HttpEntity entity) throws IOException { return EntityUtils.toString(entity); } @Override public String handleResponse( final HttpResponse response) throws HttpResponseException, IOException { return super.handleResponse(response); } }