com.box.androidsdk.content.requests

Class BoxHttpResponse

java.lang.Object

com.box.androidsdk.content.requests.BoxHttpResponse

public class BoxHttpResponse
extends java.lang.Object

Used to read HTTP responses from the Box API.

All responses from the REST API are read using this class or one of its subclasses. This class wraps HttpURLConnection in order to provide a simpler interface that can automatically handle various conditions specific to Box's API. When a response is constructed, it will throw a BoxException if the response from the API was an error. Therefore every BoxAPIResponse instance is guaranteed to represent a successful response.

This class usually isn't instantiated directly, but is instead returned after calling BoxRequest.send().

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.HttpURLConnection	mConnection
protected java.lang.String	mContentType
protected int	mResponseCode

Constructor Summary

Constructors

Constructor and Description
BoxHttpResponse(java.net.HttpURLConnection connection) Constructs a BoxAPIResponse using an HttpURLConnection.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnects this response from the server and frees up any network resources.
java.io.InputStream	getBody() Gets an InputStream for reading this response's body.
java.io.InputStream	getBody(ProgressListener listener) Gets an InputStream for reading this response's body which will report its read progress to a ProgressListener.
int	getContentLength() Gets the length of this response's body as indicated by the "Content-Length" header.
java.lang.String	getContentType()
java.net.HttpURLConnection	getHttpURLConnection() Gets the HTTP URL connection for this response.
int	getResponseCode() Gets the response code returned by the API.
java.lang.String	getStringBody() Returns a string representation of this response's body.
void	open() Open connection to the resource.

Methods inherited from class java.lang.Object

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

Field Detail

mConnection

protected final java.net.HttpURLConnection mConnection

mResponseCode

protected int mResponseCode

mContentType

protected java.lang.String mContentType

Constructor Detail

BoxHttpResponse

public BoxHttpResponse(java.net.HttpURLConnection connection)

Constructs a BoxAPIResponse using an HttpURLConnection.

Parameters:

connection - a connection that has already sent a request to the API.

Method Detail

open

public void open()
          throws java.io.IOException

Open connection to the resource.

Throws:

java.io.IOException - if an error occurs connecting to server.

getResponseCode

public int getResponseCode()

Gets the response code returned by the API.

Returns:

the response code returned by the API.

getContentLength

public int getContentLength()

Gets the length of this response's body as indicated by the "Content-Length" header.

Returns:

the length of the response's body.

getContentType

public java.lang.String getContentType()

getBody

public java.io.InputStream getBody()
                            throws BoxException

Gets an InputStream for reading this response's body.

Returns:

an InputStream for reading the response's body.

Throws:

BoxException - thrown if there was an issue getting the body including network issues.

getBody

public java.io.InputStream getBody(ProgressListener listener)
                            throws BoxException

Gets an InputStream for reading this response's body which will report its read progress to a ProgressListener.

Parameters:

listener - a listener for monitoring the read progress of the body.

Returns:

an InputStream for reading the response's body.

Throws:

BoxException - thrown if there was an issue getting the body including network issues.

disconnect

public void disconnect()
                throws BoxException

Disconnects this response from the server and frees up any network resources. The body of this response can no longer be read after it has been disconnected.

Throws:

BoxException - thrown if there was an issue closing the connection.

getStringBody

public java.lang.String getStringBody()
                               throws BoxException

Returns a string representation of this response's body. This method is used when logging this response's body. By default, it returns an empty string (to avoid accidentally logging binary data) unless the response contained an error message.

Returns:

a string representation of this response's body.

Throws:

BoxException - thrown if there was an issue getting the body.

getHttpURLConnection

public java.net.HttpURLConnection getHttpURLConnection()

Gets the HTTP URL connection for this response.

Returns:

HTTP URL connection for this response.