com.box.androidsdk.content.requests

Class BoxRequest.BoxRequestHandler<R extends BoxRequest>

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest.BoxRequestHandler<R>

Direct Known Subclasses:

BoxRequestDownload.DownloadRequestHandler, BoxRequestUpload.UploadRequestHandler

Enclosing class:

BoxRequest<T extends BoxObject,R extends BoxRequest<T,R>>

public static class BoxRequest.BoxRequestHandler<R extends BoxRequest>
extends java.lang.Object

This class handles parsing the response from Box's server into the correct data object if successful or throw the appropriate exception if not. The default implementation of this class is designed to handle JSON objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_NUM_RETRIES
protected static int	DEFAULT_RATE_LIMIT_WAIT
protected int	mNumRateLimitRetries
protected R	mRequest
static java.lang.String	OAUTH_ERROR_HEADER
static java.lang.String	OAUTH_INVALID_TOKEN
static java.lang.String	WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
BoxRequestHandler(R request)

Method Summary

Modifier and Type	Method and Description
protected void	disconnectForInterrupt(BoxHttpResponse response)
protected static int	getRetryAfterFromResponse(BoxHttpResponse response, int defaultSeconds)
boolean	isResponseSuccess(BoxHttpResponse response) Check the response returned from the server.
boolean	onException(BoxRequest request, BoxHttpResponse response, BoxException ex)
<T extends BoxObject> T	onResponse(java.lang.Class<T> clazz, BoxHttpResponse response) Parse the response from the server into the expected object T.
protected <T extends BoxObject> T	retryRateLimited(BoxHttpResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

OAUTH_ERROR_HEADER

public static final java.lang.String OAUTH_ERROR_HEADER

See Also:

Constant Field Values

OAUTH_INVALID_TOKEN

public static final java.lang.String OAUTH_INVALID_TOKEN

See Also:

Constant Field Values

WWW_AUTHENTICATE

public static final java.lang.String WWW_AUTHENTICATE

See Also:

Constant Field Values

DEFAULT_NUM_RETRIES

protected static final int DEFAULT_NUM_RETRIES

See Also:

Constant Field Values

DEFAULT_RATE_LIMIT_WAIT

protected static final int DEFAULT_RATE_LIMIT_WAIT

See Also:

Constant Field Values

mRequest

protected R extends BoxRequest mRequest

mNumRateLimitRetries

protected int mNumRateLimitRetries

Constructor Detail

BoxRequestHandler

public BoxRequestHandler(R request)

Method Detail

isResponseSuccess

public boolean isResponseSuccess(BoxHttpResponse response)

Check the response returned from the server.

Parameters:

response - the response from the server.

Returns:

true if the response is a success condition, false if the response indicates a failure.

onResponse

public <T extends BoxObject> T onResponse(java.lang.Class<T> clazz,
                                          BoxHttpResponse response)
                                   throws java.lang.IllegalAccessException,
                                          java.lang.InstantiationException,
                                          BoxException

Parse the response from the server into the expected object T. clazz is used to create a new instance of this object in this implementation, so if using this implementation, it is important that T be an instance of BoxJsonObject.

Type Parameters:

T - the class to return an instance of.

Parameters:

clazz - the class to use to construct an instance of T in which to parse data to.

response - the response from the server.

Returns:

an instance of T parsed from the server response.

Throws:

java.lang.IllegalAccessException - thrown if clazz this class does not have access to the constructor for clazz.

java.lang.InstantiationException - thrown if clazz cannot be instantiated for example if it does not have a default contsructor.

BoxException - thrown for any type of server exception or server response indicating an error.

retryRateLimited

protected <T extends BoxObject> T retryRateLimited(BoxHttpResponse response)
                                            throws BoxException

Throws:

BoxException

disconnectForInterrupt

protected void disconnectForInterrupt(BoxHttpResponse response)
                               throws BoxException

Throws:

BoxException

onException

public boolean onException(BoxRequest request,
                           BoxHttpResponse response,
                           BoxException ex)
                    throws BoxException.RefreshFailure

Parameters:

request - The request that has failed.

response - the response from sending the request.

ex - The exception thrown from sending the failed request.

Returns:

true if exception is handled well and request can be re-sent. false otherwise.

Throws:

BoxException.RefreshFailure - thrown when request cannot be retried due to a bad access token that cannoth be refreshed.

getRetryAfterFromResponse

protected static int getRetryAfterFromResponse(BoxHttpResponse response,
                                               int defaultSeconds)