com.salesforce.androidsdk.rest

Class RestResponse

java.lang.Object

com.salesforce.androidsdk.rest.RestResponse

public class RestResponse
extends java.lang.Object

RestResponse: Class to represent any REST response.

Constructor Summary

Constructors

Constructor and Description
RestResponse(Response response) Constructor

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes()
java.io.InputStream	asInputStream() Streams the response content.
JSONArray	asJSONArray() JSONArray is built the first time the method is called.
JSONObject	asJSONObject() JSONObject is built the first time the method is called.
java.lang.String	asString() String is built the first time the method is called.
void	consume() Fully consume response entity content and closes content stream Must be called before returning control to the UI thread
void	consumeQuietly() Fully consume a response and swallow any exceptions thrown during the process.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllHeaders() Returns all headers associated with this response.
java.lang.String	getContentType() Return content type
Response	getRawResponse() Method to get the "raw" response (i.e.
int	getStatusCode()
boolean	isSuccess()
static boolean	isSuccess(int statusCode)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestResponse

public RestResponse(Response response)

Constructor

Parameters:

response - okHttp Response object.

Method Detail

getAllHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllHeaders()

Returns all headers associated with this response.

Returns:

Map containing all headers.

getStatusCode

public int getStatusCode()

Returns:

HTTP status code of the response

isSuccess

public boolean isSuccess()

Returns:

true for response with 2xx status codes

isSuccess

public static boolean isSuccess(int statusCode)

Returns:

true for response with 2xx status codes

consume

public void consume()
             throws java.io.IOException

Fully consume response entity content and closes content stream Must be called before returning control to the UI thread

Throws:

java.io.IOException

consumeQuietly

public void consumeQuietly()

Fully consume a response and swallow any exceptions thrown during the process.

See Also:

consume()

asBytes

public byte[] asBytes()
               throws java.io.IOException

Returns:

byte[] for entire response

Throws:

java.io.IOException

getContentType

public java.lang.String getContentType()

Return content type

Returns:

value of content-type header or null if header not found

asString

public java.lang.String asString()
                          throws java.io.IOException

String is built the first time the method is called.

Returns:

string for entire response

Throws:

java.io.IOException

asJSONObject

public JSONObject asJSONObject()
                        throws JSONException,
                               java.io.IOException

JSONObject is built the first time the method is called.

Returns:

JSONObject for response

Throws:

JSONException

java.io.IOException

asJSONArray

public JSONArray asJSONArray()
                      throws JSONException,
                             java.io.IOException

JSONArray is built the first time the method is called.

Returns:

JSONObject for response

Throws:

JSONException

java.io.IOException

asInputStream

public java.io.InputStream asInputStream()
                                  throws java.io.IOException

Streams the response content. This stream must be consumed either by reading from it and calling InputStream.close(), or calling consume() to discard the contents.

> If the response is consumed as a stream, asBytes() will return an empty array, asString() will return an empty string and both asJSONArray() and asJSONObject() will throw exceptions.

Returns:

an InputStream from the response content

Throws:

java.io.IOException - if the stream could not be created or has already been consumed

getRawResponse

public Response getRawResponse()

Method to get the "raw" response (i.e. the underlying OkHttp3.Response object). null is return if the response was already consumed. It is the responsibility of the application to close the response after consuming it.

Returns:

raw response as Response

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object