Class BasicResponseHandler

java.lang.Object

org.apache.http.impl.client.BasicResponseHandler

All Implemented Interfaces:

ResponseHandler<String>

@Immutable
public class BasicResponseHandler
extends Object
implements ResponseHandler<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(org.apache.http.client.methods.HttpUriRequest, ResponseHandler), HttpClient may handle redirects (3xx responses) internally.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
BasicResponseHandler()

Method Summary

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

Methods inherited from class Object

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

Constructor Details

BasicResponseHandler

public BasicResponseHandler()

Method Details

handleResponse

public String handleResponse(HttpResponse response)
                      throws HttpResponseException,
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<String>

Parameters:

response - The response to process

Returns:

A value determined by the response

Throws:

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

HttpResponseException