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.

Direct Known Subclasses:

BoxRequestBatch, BoxRequestDownload, BoxRequestItem, BoxRequestsBookmark.DeleteBookmark, BoxRequestsBookmark.DeleteTrashedBookmark, BoxRequestsComment.DeleteComment, BoxRequestsComment.UpdateComment, BoxRequestsEvent.EventRealTimeServerRequest, BoxRequestsEvent.GetEnterpriseEvents, BoxRequestsEvent.GetUserEvents, BoxRequestsEvent.LongPollMessageRequest, BoxRequestsFile.DeleteFile, BoxRequestsFile.DeleteFileVersion, BoxRequestsFile.DeleteTrashedFile, BoxRequestsFolder.DeleteFolder, BoxRequestsFolder.DeleteTrashedFolder, BoxRequestsFolder.GetTrashedItems, BoxRequestsMetadata.AddFileMetadata, BoxRequestsMetadata.DeleteFileMetadata, BoxRequestsMetadata.GetFileMetadata, BoxRequestsMetadata.GetMetadataTemplates, BoxRequestsMetadata.GetMetadataTemplateSchema, BoxRequestsMetadata.UpdateFileMetadata, BoxRequestsSearch.Search, BoxRequestsShare.AddCollaboration, BoxRequestsShare.DeleteCollaboration, BoxRequestsShare.GetCollaborationInfo, BoxRequestsShare.GetPendingCollaborations, BoxRequestsShare.GetSharedLink, BoxRequestsShare.UpdateCollaboration, BoxRequestsUser.DeleteEnterpriseUser, BoxRequestUpload

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

This class represents a request made to the Box server.

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 BoxSession	mSession

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

Methods

Modifier and Type	Method and Description
protected java.net.URL	buildUrl()
protected com.box.androidsdk.content.requests.BoxHttpRequest	createHttpRequest()
protected java.lang.String	createQuery(java.util.Map<java.lang.String,java.lang.String> map)
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.
java.lang.String	getStringBody() Gets the string body for the request.
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 void	parseHashMapEntry(JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
protected JsonValue	parseJsonObject(java.lang.Object obj)
T	send() Synchronously make the request to Box and handle the response appropriately.
protected void	setBody(com.box.androidsdk.content.requests.BoxHttpRequest request)
R	setContentType(BoxRequest.ContentTypes contentType)
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)
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, equals, finalize, getClass, hashCode, 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 ProgressListener mListener

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)

setContentType

public R setContentType(BoxRequest.ContentTypes contentType)

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 -

Returns:

send

public 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.

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

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

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(JsonObject jsonBody,
                     java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

parseJsonObject

protected JsonValue parseJsonObject(java.lang.Object obj)

logDebug

protected void logDebug(BoxHttpResponse response)
                 throws BoxException

Throws:

BoxException

logRequest

protected void logRequest()