001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.impl.client;
029
030import java.io.IOException;
031
032import org.apache.http.HttpEntity;
033import org.apache.http.HttpResponse;
034import org.apache.http.annotation.Contract;
035import org.apache.http.annotation.ThreadingBehavior;
036import org.apache.http.client.HttpResponseException;
037import org.apache.http.util.EntityUtils;
038
039/**
040 * A {@link org.apache.http.client.ResponseHandler} that returns the response body as a String
041 * for successful (2xx) responses. If the response code was &gt;= 300, the response
042 * body is consumed and an {@link org.apache.http.client.HttpResponseException} is thrown.
043 * <p>
044 * If this is used with
045 * {@link org.apache.http.client.HttpClient#execute(
046 *  org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler)},
047 * HttpClient may handle redirects (3xx responses) internally.
048 * </p>
049 *
050 * @since 4.0
051 */
052@Contract(threading = ThreadingBehavior.IMMUTABLE)
053public class BasicResponseHandler extends AbstractResponseHandler<String> {
054
055    /**
056     * Returns the entity as a body as a String.
057     */
058    @Override
059    public String handleEntity(final HttpEntity entity) throws IOException {
060        return EntityUtils.toString(entity);
061    }
062
063    @Override
064    public String handleResponse(
065            final HttpResponse response) throws HttpResponseException, IOException {
066        return super.handleResponse(response);
067    }
068
069}