cz.msebera.android.httpclient.impl.client

Class BasicResponseHandler

java.lang.Object

cz.msebera.android.httpclient.impl.client.BasicResponseHandler

All Implemented Interfaces:

ResponseHandler<java.lang.String>

@Immutable
public class BasicResponseHandler
extends java.lang.Object
implements ResponseHandler<java.lang.String>

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( cz.msebera.android.httpclient.client.methods.HttpUriRequest, ResponseHandler), HttpClient may handle redirects (3xx responses) internally.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
BasicResponseHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	handleResponse(HttpResponse response) Returns the response body as a String if the response was successful (a 2xx status code).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicResponseHandler

public BasicResponseHandler()

Method Detail

handleResponse

public java.lang.String handleResponse(HttpResponse response)
                                throws HttpResponseException,
                                       java.io.IOException

Returns the response body as a String if the response was successful (a 2xx status code). If no response body exists, this returns null. If the response was unsuccessful (>= 300 status code), throws an HttpResponseException.

Specified by:

handleResponse in interface ResponseHandler<java.lang.String>

Parameters:

response - The response to process

Returns:

A value determined by the response

Throws:

ClientProtocolException - in case of an http protocol error

java.io.IOException - in case of a problem or the connection was aborted

HttpResponseException