Package org.apache.http.impl.client

Class BasicResponseHandler

java.lang.Object

org.apache.http.impl.client.AbstractResponseHandler<java.lang.String>

org.apache.http.impl.client.BasicResponseHandler

All Implemented Interfaces:

ResponseHandler<java.lang.String>

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

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
BasicResponseHandler()

Method Summary

Modifier and Type	Method	Description
java.lang.String	handleEntity(HttpEntity entity)	Returns the entity as a body as a String.
java.lang.String	handleResponse(HttpResponse response)	Read the entity from the response body and pass it to the entity handler method if the response was successful (a 2xx status code).

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicResponseHandler

public BasicResponseHandler()

Method Detail

handleEntity

public java.lang.String handleEntity(HttpEntity entity)
                              throws java.io.IOException

Returns the entity as a body as a String.

Specified by:

handleEntity in class AbstractResponseHandler<java.lang.String>

Throws:

java.io.IOException

handleResponse

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

Description copied from class: AbstractResponseHandler

Read the entity from the response body and pass it to the entity handler method 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>

Overrides:

handleResponse in class AbstractResponseHandler<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