com.box.sdk

Class BoxAPIResponse

Object

BoxAPIResponse

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BoxJSONResponse

public class BoxAPIResponse
extends Object
implements Closeable

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 contructed, it will throw a BoxAPIException 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 BoxAPIRequest.send().

Constructor Summary

Constructors

Constructor and Description
BoxAPIResponse() Constructs an empty BoxAPIResponse without an associated HttpURLConnection.
BoxAPIResponse(int responseCode, String requestMethod, String requestUrl, Map<String,List<String>> headers) Constructs a BoxAPIResponse with a http response code and response headers.
BoxAPIResponse(int code, String requestMethod, String requestUrl, Map<String,List<String>> headers, InputStream body, String contentType, long contentLength)

Method Summary

Modifier and Type	Method and Description
protected String	bodyToString() Returns a string representation of this response's body.
void	close()
void	disconnect() Disconnects this response from the server and frees up any network resources.
InputStream	getBody() Gets an InputStream for reading this response's body.
InputStream	getBody(ProgressListener listener) Gets an InputStream for reading this response's body which will report its read progress to a ProgressListener.
long	getContentLength() Gets the length of this response's body as indicated by the "Content-Length" header.
String	getHeaderField(String fieldName) Gets the value of the given header field.
Map<String,List<String>>	getHeaders()
protected String	getRequestMethod()
protected String	getRequestUrl()
int	getResponseCode() Gets the response code returned by the API.
String	toString()

Methods inherited from class Object

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

Constructor Detail

BoxAPIResponse

public BoxAPIResponse()

Constructs an empty BoxAPIResponse without an associated HttpURLConnection.

BoxAPIResponse

public BoxAPIResponse(int responseCode,
                      String requestMethod,
                      String requestUrl,
                      Map<String,List<String>> headers)

Constructs a BoxAPIResponse with a http response code and response headers.

Parameters:

responseCode - http response code

headers - map of headers

BoxAPIResponse

public BoxAPIResponse(int code,
                      String requestMethod,
                      String requestUrl,
                      Map<String,List<String>> headers,
                      InputStream body,
                      String contentType,
                      long contentLength)

Method Detail

getResponseCode

public int getResponseCode()

Gets the response code returned by the API.

Returns:

the response code returned by the API.

getContentLength

public long getContentLength()

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

Returns:

the length of the response's body.

getHeaderField

public String getHeaderField(String fieldName)

Gets the value of the given header field.

Parameters:

fieldName - name of the header field.

Returns:

value of the header.

getBody

public InputStream getBody()

Gets an InputStream for reading this response's body.

Returns:

an InputStream for reading the response's body.

getBody

public InputStream getBody(ProgressListener listener)

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.

disconnect

public void disconnect()

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.

getHeaders

public Map<String,List<String>> getHeaders()

Returns:

A Map containg headers on this Box API Response.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

bodyToString

protected String bodyToString()

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.

getRequestMethod

protected String getRequestMethod()

getRequestUrl

protected String getRequestUrl()