com.box.boxjavalibv2.requests.requestobjects

Class BoxFileUploadRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxFileUploadRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxFileUploadRequestObject
extends BoxDefaultRequestObject

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.http.HttpEntity	getEntity() Get entity, which will be put into request body.
BoxFileUploadRequestObject	setContentMD5(String sha1) Set the content MD5 in the request.
BoxFileUploadRequestObject	setIfMatch(String etag) This is for upload new version request only.
BoxFileUploadRequestObject	setListener(IFileTransferListener listener) Set upload listener.
BoxFileUploadRequestObject	setLocalFileCreatedAt(Date createdAt) Set the time that the file was locally created.
BoxFileUploadRequestObject	setLocalFileLastModifiedAt(Date modifiedAt) Set the time that the file was locally last modified.
BoxFileUploadRequestObject	setMultipartMIME(MultipartEntityWithProgressListener mime)
static BoxFileUploadRequestObject	uploadFileRequestObject(String parentId, String fileName, File file, IBoxJSONParser parser) BoxFileUploadRequestObject for upload file request.
static BoxFileUploadRequestObject	uploadFileRequestObject(String parentId, String fileName, InputStream inputStream) BoxFileUploadRequestObject for upload file request.
static BoxFileUploadRequestObject	uploadNewVersionRequestObject(String name, File file) BoxFileUploadRequestObject for upload a new version of a file.
static BoxFileUploadRequestObject	uploadNewVersionRequestObject(String name, InputStream inputStream) BoxFileUploadRequestObject for upload a new version of a file.

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

addField, addFields, addHeader, addQueryParam, get, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, put, setJSONParser, setPage

Methods inherited from class java.lang.Object

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

Method Detail

uploadFileRequestObject

public static BoxFileUploadRequestObject uploadFileRequestObject(String parentId,
                                                 String fileName,
                                                 File file,
                                                 IBoxJSONParser parser)
                                                          throws BoxRestException,
                                                                 BoxJSONException

BoxFileUploadRequestObject for upload file request. Note: for uploading a new version of the file, please use uploadNewVersionRequestObject().

Parameters:

parentId - id of the parent folder

fileName - name of the file

file - file to be uploaded

Returns:

BoxFileUploadRequestObject

Throws:

BoxRestException

BoxJSONException

uploadFileRequestObject

public static BoxFileUploadRequestObject uploadFileRequestObject(String parentId,
                                                 String fileName,
                                                 InputStream inputStream)
                                                          throws BoxRestException

BoxFileUploadRequestObject for upload file request. Note: for uploading a new version of the file, please use uploadNewVersionRequestObject().

Parameters:

parentId - id of the parent folder

fileName - name of the file

inputStream - InputStream of the file to be uploaded

Returns:

BoxFileUploadRequestObject

Throws:

BoxRestException

uploadNewVersionRequestObject

public static BoxFileUploadRequestObject uploadNewVersionRequestObject(String name,
                                                       File file)
                                                                throws BoxRestException

BoxFileUploadRequestObject for upload a new version of a file.

Parameters:

name - name of the file

file - file to be uploaded

Returns:

BoxFileUploadRequestObject

Throws:

BoxRestException - exception

uploadNewVersionRequestObject

public static BoxFileUploadRequestObject uploadNewVersionRequestObject(String name,
                                                       InputStream inputStream)
                                                                throws BoxRestException

BoxFileUploadRequestObject for upload a new version of a file.

Parameters:

name - name of the file

inputStream - input stream of the file uploaded.

Returns:

BoxFileUploadRequestObject

Throws:

BoxRestException - exception

setMultipartMIME

public BoxFileUploadRequestObject setMultipartMIME(MultipartEntityWithProgressListener mime)
                                            throws BoxRestException

Throws:

BoxRestException

setListener

public BoxFileUploadRequestObject setListener(IFileTransferListener listener)

Set upload listener.

Parameters:

listener - upload listener

setContentMD5

public BoxFileUploadRequestObject setContentMD5(String sha1)

Set the content MD5 in the request. This is used in upload file request, it can make sure that the file is not corrupted in transit. In case of the sha1 is different than the sha1 calculated on server, request is going to fail.

Parameters:

sha1 - sha1

setLocalFileCreatedAt

public BoxFileUploadRequestObject setLocalFileCreatedAt(Date createdAt)
                                                 throws UnsupportedEncodingException

Set the time that the file was locally created.

Parameters:

createdAt -

Returns:

Throws:

UnsupportedEncodingException

setLocalFileLastModifiedAt

public BoxFileUploadRequestObject setLocalFileLastModifiedAt(Date modifiedAt)
                                                      throws UnsupportedEncodingException

Set the time that the file was locally last modified.

Parameters:

createdAt -

Returns:

Throws:

UnsupportedEncodingException

setIfMatch

public BoxFileUploadRequestObject setIfMatch(String etag)

This is for upload new version request only. Set the If-Match header can be included to ensure that client only overwrites the file if it knows about the latest version.

Parameters:

etag - etag

Returns:

BoxFileUploadRequestObject

getEntity

public org.apache.http.HttpEntity getEntity()

Description copied from interface: IBoxRequestObject

Get entity, which will be put into request body.

Specified by:

getEntity in interface IBoxRequestObject

Overrides:

getEntity in class BoxDefaultRequestObject

Returns:

HttpEntity.