michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.client;
michael@0: 
michael@0: import java.io.IOException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpEntity;
michael@0: import ch.boye.httpclientandroidlib.HttpResponse;
michael@0: import ch.boye.httpclientandroidlib.StatusLine;
michael@0: import ch.boye.httpclientandroidlib.client.ResponseHandler;
michael@0: import ch.boye.httpclientandroidlib.client.HttpResponseException;
michael@0: import ch.boye.httpclientandroidlib.util.EntityUtils;
michael@0: 
michael@0: /**
michael@0:  * A {@link ResponseHandler} that returns the response body as a String
michael@0:  * for successful (2xx) responses. If the response code was >= 300, the response
michael@0:  * body is consumed and an {@link HttpResponseException} is thrown.
michael@0:  *
michael@0:  * If this is used with
michael@0:  * {@link ch.boye.httpclientandroidlib.client.HttpClient#execute(
michael@0:  *  ch.boye.httpclientandroidlib.client.methods.HttpUriRequest, ResponseHandler)},
michael@0:  * HttpClient may handle redirects (3xx responses) internally.
michael@0:  *
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @Immutable
michael@0: public class BasicResponseHandler implements ResponseHandler<String> {
michael@0: 
michael@0:     /**
michael@0:      * Returns the response body as a String if the response was successful (a
michael@0:      * 2xx status code). If no response body exists, this returns null. If the
michael@0:      * response was unsuccessful (>= 300 status code), throws an
michael@0:      * {@link HttpResponseException}.
michael@0:      */
michael@0:     public String handleResponse(final HttpResponse response)
michael@0:             throws HttpResponseException, IOException {
michael@0:         StatusLine statusLine = response.getStatusLine();
michael@0:         if (statusLine.getStatusCode() >= 300) {
michael@0:             throw new HttpResponseException(statusLine.getStatusCode(),
michael@0:                     statusLine.getReasonPhrase());
michael@0:         }
michael@0: 
michael@0:         HttpEntity entity = response.getEntity();
michael@0:         return entity == null ? null : EntityUtils.toString(entity);
michael@0:     }
michael@0: 
michael@0: }