Home | History | Annotate | Download | only in client
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/BasicResponseHandler.java $
      3  * $Revision: 677240 $
      4  * $Date: 2008-07-16 04:25:47 -0700 (Wed, 16 Jul 2008) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.impl.client;
     33 
     34 import java.io.IOException;
     35 
     36 import org.apache.http.HttpEntity;
     37 import org.apache.http.HttpResponse;
     38 import org.apache.http.StatusLine;
     39 import org.apache.http.client.ResponseHandler;
     40 import org.apache.http.client.HttpResponseException;
     41 import org.apache.http.util.EntityUtils;
     42 
     43 /**
     44  * A {@link ResponseHandler} that returns the response body as a String
     45  * for successful (2xx) responses. If the response code was >= 300, the response
     46  * body is consumed and an {@link HttpResponseException} is thrown.
     47  *
     48  * If this is used with
     49  * {@link org.apache.http.client.HttpClient#execute(
     50  *  org.apache.http.client.methods.HttpUriRequest, ResponseHandler)},
     51  * HttpClient may handle redirects (3xx responses) internally.
     52  *
     53  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     54  *
     55  * @version $Revision: 677240 $
     56  *
     57  * @since 4.0
     58  *
     59  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     60  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     61  *     for further details.
     62  */
     63 @Deprecated
     64 public class BasicResponseHandler implements ResponseHandler<String> {
     65 
     66     /**
     67      * Returns the response body as a String if the response was successful (a
     68      * 2xx status code). If no response body exists, this returns null. If the
     69      * response was unsuccessful (>= 300 status code), throws an
     70      * {@link HttpResponseException}.
     71      */
     72     public String handleResponse(final HttpResponse response)
     73             throws HttpResponseException, IOException {
     74         StatusLine statusLine = response.getStatusLine();
     75         if (statusLine.getStatusCode() >= 300) {
     76             throw new HttpResponseException(statusLine.getStatusCode(),
     77                     statusLine.getReasonPhrase());
     78         }
     79 
     80         HttpEntity entity = response.getEntity();
     81         return entity == null ? null : EntityUtils.toString(entity);
     82     }
     83 
     84 }
     85