com.box.androidsdk.content.requests

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

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<T,R>

Type Parameters:

T - The object that data from the server should be parsed into.

R - The child class extending this object.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestBatch, BoxRequestDownload, BoxRequestItem, BoxRequestItemDelete, BoxRequestsComment.DeleteComment, BoxRequestsComment.UpdateComment, BoxRequestsEvent.EventRealTimeServerRequest, BoxRequestsEvent.GetEnterpriseEvents, BoxRequestsEvent.GetUserEvents, BoxRequestsEvent.LongPollMessageRequest, BoxRequestsFile.DeleteFileVersion, BoxRequestsFolder.GetTrashedItems, BoxRequestsMetadata.AddFileMetadata, BoxRequestsMetadata.DeleteFileMetadata, BoxRequestsMetadata.GetFileMetadata, BoxRequestsMetadata.GetMetadataTemplates, BoxRequestsMetadata.GetMetadataTemplateSchema, BoxRequestsMetadata.UpdateFileMetadata, BoxRequestsShare.AddCollaboration, BoxRequestsShare.DeleteCollaboration, BoxRequestsShare.GetCollaborationInfo, BoxRequestsShare.GetPendingCollaborations, BoxRequestsShare.UpdateCollaboration, BoxRequestsShare.UpdateOwner, BoxRequestsUser.DeleteEnterpriseUser

public abstract class BoxRequest<T extends BoxObject,R extends BoxRequest<T,R>>
extends java.lang.Object
implements java.io.Serializable

This class represents a request made to the Box server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxRequest.BoxRequestHandler<R extends BoxRequest> This class handles parsing the response from Box's server into the correct data object if successful or throw the appropriate exception if not.
static class	BoxRequest.ContentTypes The different content types used to encode data sent to the Box Server.
static class	BoxRequest.Methods The different type of methods to communicate with the Box server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_OBJECT
protected java.util.LinkedHashMap<java.lang.String,java.lang.Object>	mBodyMap
protected BoxRequest.ContentTypes	mContentType
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	mHeaderMap
protected ProgressListener	mListener
protected java.util.HashMap<java.lang.String,java.lang.String>	mQueryMap
protected BoxRequest.Methods	mRequestMethod
protected java.lang.String	mRequestUrlString
protected boolean	mRequiresSocket
protected BoxSession	mSession
protected int	mTimeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BoxRequest(BoxRequest request) Helper constructor used to copy the fields of one BoxRequest to another.
	BoxRequest(java.lang.Class<T> clazz, java.lang.String requestUrl, BoxSession session) Constructs a new BoxRequest.

Method Summary

Modifier and Type	Method and Description
protected java.net.URL	buildUrl()
protected void	createHeaderMap()
protected com.box.androidsdk.content.requests.BoxHttpRequest	createHttpRequest()
protected java.lang.String	createQuery(java.util.Map<java.lang.String,java.lang.String> map)
boolean	equals(java.lang.Object o)
protected java.lang.String	getIfMatchEtag()
protected java.lang.String	getIfNoneMatchEtag()
BoxRequest.BoxRequestHandler	getRequestHandler() Gets the request handler.
BoxSession	getSession() Gets session used to authenticate this request.
protected java.net.Socket	getSocket() This method requires mRequiresSocket to be set to true before connecting.
java.lang.String	getStringBody() Gets the string body for the request.
protected T	handleSendForCachedResult() Default implementation for sending a request.
protected <R extends BoxRequest & BoxCacheableRequest> BoxFutureTask<T>	handleToTaskForCachedResult() Default implementation for getting a task to execute the request.
protected void	handleUpdateCache(BoxResponse<T> response) If available, makes a call to update the cache with the provided result
int	hashCode()
protected void	importRequestContentMapsFrom(BoxRequest source) Copies data from query and body maps into the current request.
protected void	logDebug(BoxHttpResponse response)
protected void	logRequest()
protected T	onSend() Synchronously make the request to Box and handle the response appropriately.
protected void	onSendCompleted(BoxResponse<T> response) Post action that will be performed after a successful send occurs.
protected void	parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
protected com.eclipsesource.json.JsonValue	parseJsonObject(java.lang.Object obj)
T	send() Synchronously make the request to Box and handle the response appropriately.
protected BoxHttpResponse	sendRequest(com.box.androidsdk.content.requests.BoxHttpRequest request, java.net.HttpURLConnection connection)
protected void	setBody(com.box.androidsdk.content.requests.BoxHttpRequest request)
R	setContentType(BoxRequest.ContentTypes contentType) Set the content type encoding.
protected void	setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)
protected R	setIfMatchEtag(java.lang.String etag)
protected R	setIfNoneMatchEtag(java.lang.String etag)
R	setRequestHandler(BoxRequest.BoxRequestHandler handler) Sets a request handler to handle sending the request.
R	setTimeOut(int timeOut) Set the time out for this request in milliseconds via the method in HttpUrlConnection.
BoxFutureTask<T>	toTask() Creates a BoxFutureTask to make the request asynchronously.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_OBJECT

public static final java.lang.String JSON_OBJECT

See Also:

Constant Field Values

mRequestUrlString

protected java.lang.String mRequestUrlString

mRequestMethod

protected BoxRequest.Methods mRequestMethod

mQueryMap

protected java.util.HashMap<java.lang.String,java.lang.String> mQueryMap

mBodyMap

protected java.util.LinkedHashMap<java.lang.String,java.lang.Object> mBodyMap

mHeaderMap

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> mHeaderMap

mContentType

protected BoxRequest.ContentTypes mContentType

mSession

protected BoxSession mSession

mListener

protected transient ProgressListener mListener

mTimeout

protected int mTimeout

mRequiresSocket

protected boolean mRequiresSocket

Constructor Detail

BoxRequest

public BoxRequest(java.lang.Class<T> clazz,
                  java.lang.String requestUrl,
                  BoxSession session)

Constructs a new BoxRequest.

Parameters:

clazz - The class of the object that should be returned, the class specified by the child in T.

requestUrl - the url to use to connect to Box.

session - the session used to authenticate the given request.

BoxRequest

protected BoxRequest(BoxRequest request)

Helper constructor used to copy the fields of one BoxRequest to another.

Parameters:

request - the request to copy data from.

Method Detail

importRequestContentMapsFrom

protected void importRequestContentMapsFrom(BoxRequest source)

Copies data from query and body maps into the current request.

Parameters:

source - the request to copy data from.

getSession

public BoxSession getSession()

Gets session used to authenticate this request.

Returns:

the session used to authenticate this request.

getRequestHandler

public BoxRequest.BoxRequestHandler getRequestHandler()

Gets the request handler.

Returns:

request handler.

setRequestHandler

public R setRequestHandler(BoxRequest.BoxRequestHandler handler)

Sets a request handler to handle sending the request.

Parameters:

handler - the request handler to use for handling given request.

Returns:

current request.

setContentType

public R setContentType(BoxRequest.ContentTypes contentType)

Set the content type encoding.

Parameters:

contentType - sets the encoding type of this request.

Returns:

current request.

setTimeOut

public R setTimeOut(int timeOut)

Set the time out for this request in milliseconds via the method in HttpUrlConnection.

Warning: if the hostname resolves to multiple IP addresses, this client will try each in RFC 3484 order. If connecting to each of these addresses fails, multiple timeouts will elapse before the connect attempt throws an exception. Host names that support both IPv6 and IPv4 always have at least 2 IP addresses.

Parameters:

timeOut - time in milliseconds to wait for request to finish.

Returns:

current request.

send

public final T send()
             throws BoxException

Synchronously make the request to Box and handle the response appropriately.

Returns:

the expected BoxObject if the request is successful.

Throws:

BoxException - thrown if there was a problem with handling the request.

onSend

protected T onSend()
            throws BoxException

Synchronously make the request to Box and handle the response appropriately.

Returns:

the expected BoxObject if the request is successful.

Throws:

BoxException - thrown if there was a problem with handling the request.

onSendCompleted

protected void onSendCompleted(BoxResponse<T> response)
                        throws BoxException

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.

toTask

public BoxFutureTask<T> toTask()

Creates a BoxFutureTask to make the request asynchronously.

Returns:

a BoxFutureTask that can be used to make the same request as the send method asynchronously.

createHttpRequest

protected com.box.androidsdk.content.requests.BoxHttpRequest createHttpRequest()
                                                                        throws java.io.IOException,
                                                                               BoxException

Throws:

java.io.IOException

BoxException

sendRequest

protected BoxHttpResponse sendRequest(com.box.androidsdk.content.requests.BoxHttpRequest request,
                                      java.net.HttpURLConnection connection)
                               throws java.io.IOException,
                                      BoxException

Throws:

java.io.IOException

BoxException

buildUrl

protected java.net.URL buildUrl()
                         throws java.net.MalformedURLException,
                                java.io.UnsupportedEncodingException

Throws:

java.net.MalformedURLException

java.io.UnsupportedEncodingException

createQuery

protected java.lang.String createQuery(java.util.Map<java.lang.String,java.lang.String> map)
                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

createHeaderMap

protected void createHeaderMap()

setHeaders

protected void setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)

setIfMatchEtag

protected R setIfMatchEtag(java.lang.String etag)

getIfMatchEtag

protected java.lang.String getIfMatchEtag()

setIfNoneMatchEtag

protected R setIfNoneMatchEtag(java.lang.String etag)

getIfNoneMatchEtag

protected java.lang.String getIfNoneMatchEtag()

setBody

protected void setBody(com.box.androidsdk.content.requests.BoxHttpRequest request)
                throws java.io.IOException

Throws:

java.io.IOException

getStringBody

public java.lang.String getStringBody()
                               throws java.io.UnsupportedEncodingException

Gets the string body for the request.

Returns:

the string body associated with this request.

Throws:

java.io.UnsupportedEncodingException - thrown if there was a problem with the encoding of the body.

parseHashMapEntry

protected void parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody,
                                 java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

parseJsonObject

protected com.eclipsesource.json.JsonValue parseJsonObject(java.lang.Object obj)

logDebug

protected void logDebug(BoxHttpResponse response)
                 throws BoxException

Throws:

BoxException

logRequest

protected void logRequest()

handleSendForCachedResult

protected T handleSendForCachedResult()
                               throws BoxException

Default implementation for sending a request. If fromCache is false, this will default to the standard #send() method.

Returns:

The result of sending the request to cache implementation.

Throws:

BoxException - Exception from sending the request. A BoxException.CacheImplementationNotFound will be thrown if a cache implementation is not provided in BoxConfig and fromCache is true

handleToTaskForCachedResult

protected <R extends BoxRequest & BoxCacheableRequest> BoxFutureTask<T> handleToTaskForCachedResult()
                                                                                             throws BoxException

Default implementation for getting a task to execute the request.

Type Parameters:

R - A BoxRequest that implements BoxCaceableRequest

Returns:

The task used to get data from cache implementation.

Throws:

BoxException - thrown if there is no cache implementation set in BoxConfig.

handleUpdateCache

protected void handleUpdateCache(BoxResponse<T> response)
                          throws BoxException

If available, makes a call to update the cache with the provided result

Parameters:

response - the new result to update the cache with

Throws:

BoxException - thrown if there was an issue updating cache for given response.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getSocket

protected java.net.Socket getSocket()

This method requires mRequiresSocket to be set to true before connecting.

Returns:

the socket that ran this request if one was created for it.