Package org.apache.http.impl.client
Class BasicResponseHandler
java.lang.Object
org.apache.http.impl.client.AbstractResponseHandler<String>
org.apache.http.impl.client.BasicResponseHandler
- All Implemented Interfaces:
ResponseHandler<String>
@Contract(threading=IMMUTABLE)
public class BasicResponseHandler
extends AbstractResponseHandler<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 -
Method Summary
Modifier and TypeMethodDescriptionhandleEntity
(org.apache.http.HttpEntity entity) Returns the entity as a body as a String.handleResponse
(org.apache.http.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).
-
Constructor Details
-
BasicResponseHandler
public BasicResponseHandler()
-
-
Method Details
-
handleEntity
Returns the entity as a body as a String.- Specified by:
handleEntity
in classAbstractResponseHandler<String>
- Throws:
IOException
-
handleResponse
public String handleResponse(org.apache.http.HttpResponse response) throws HttpResponseException, 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 anHttpResponseException
.- Specified by:
handleResponse
in interfaceResponseHandler<String>
- Overrides:
handleResponse
in classAbstractResponseHandler<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 abortedHttpResponseException
-