com.box.androidsdk.content.models

Class BoxUploadSession

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxUploadSession

All Implemented Interfaces:

java.io.Serializable

public class BoxUploadSession
extends BoxJsonObject

Class representing a box upload session for supporting multiput e.g. { "total_parts": 2, "part_size": 8388608, "session_endpoints": { "list_parts": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts", "commit": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit", "upload_part": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD", "status": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD", "abort": "https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "session_expires_at": "2017-04-18T01:45:15Z", "id": "F971964745A5CD0C001BBE4E58196BFD", "type": "upload_session", "num_parts_processed": 0 }

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_ID
static java.lang.String	FIELD_NUM_PARTS_PROCESSED
static java.lang.String	FIELD_PART_SIZE
static java.lang.String	FIELD_SESSION_ENDPOINTS
static java.lang.String	FIELD_SESSION_EXPIRES_AT
static java.lang.String	FIELD_TOTAL_PARTS
static java.lang.String	FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxUploadSession() Constructs an empty BoxUploadSession object.
BoxUploadSession(com.eclipsesource.json.JsonObject object) Constructs an empty BoxUploadSession object.

Method Summary

Modifier and Type	Method and Description
static int	getChunkSize(BoxUploadSession uploadSession, int partNumber, long fileSize) Computes the actual bytes to be sent in a part, which equals the partsize for all parts except the last.
BoxUploadSessionEndpoints	getEndpoints() Get an endpoints object for the session
java.util.Date	getExpiresAt() Get expires at date for the session
java.util.ArrayList<java.lang.String>	getFieldPartsSha1() Return stored list of sha1s for parts
java.lang.String	getId() Get the session id
int	getNumPartsProcessed() Get num of parts processed
int	getPartSize() Get part size in bytes
java.lang.String	getSha1()
int	getTotalParts() Get total parts for the session
void	setPartsSha1(java.util.List<java.lang.String> sha1s) Util method for storing sha1 for parts being uploaded
void	setSha1(java.lang.String sha1) Util method for sha1 for the file.

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_TOTAL_PARTS

public static final java.lang.String FIELD_TOTAL_PARTS

See Also:

Constant Field Values

FIELD_PART_SIZE

public static final java.lang.String FIELD_PART_SIZE

See Also:

Constant Field Values

FIELD_SESSION_ENDPOINTS

public static final java.lang.String FIELD_SESSION_ENDPOINTS

See Also:

Constant Field Values

FIELD_SESSION_EXPIRES_AT

public static final java.lang.String FIELD_SESSION_EXPIRES_AT

See Also:

Constant Field Values

FIELD_ID

public static final java.lang.String FIELD_ID

See Also:

Constant Field Values

FIELD_NUM_PARTS_PROCESSED

public static final java.lang.String FIELD_NUM_PARTS_PROCESSED

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxUploadSession

public BoxUploadSession()

Constructs an empty BoxUploadSession object.

BoxUploadSession

public BoxUploadSession(com.eclipsesource.json.JsonObject object)

Constructs an empty BoxUploadSession object.

Parameters:

object - jsonObject to use to create an instance of this class.

Method Detail

getTotalParts

public int getTotalParts()

Get total parts for the session

Returns:

getNumPartsProcessed

public int getNumPartsProcessed()

Get num of parts processed

Returns:

getPartSize

public int getPartSize()

Get part size in bytes

Returns:

getEndpoints

public BoxUploadSessionEndpoints getEndpoints()

Get an endpoints object for the session

getExpiresAt

public java.util.Date getExpiresAt()

Get expires at date for the session

Returns:

getId

public java.lang.String getId()

Get the session id

Returns:

setSha1

public void setSha1(java.lang.String sha1)

Util method for sha1 for the file.

getSha1

public java.lang.String getSha1()

setPartsSha1

public void setPartsSha1(java.util.List<java.lang.String> sha1s)

Util method for storing sha1 for parts being uploaded

getFieldPartsSha1

public java.util.ArrayList<java.lang.String> getFieldPartsSha1()

Return stored list of sha1s for parts

Returns:

getChunkSize

public static int getChunkSize(BoxUploadSession uploadSession,
                               int partNumber,
                               long fileSize)

Computes the actual bytes to be sent in a part, which equals the partsize for all parts except the last.

Parameters:

uploadSession -

partNumber -

fileSize -

Returns: