com.baasbox.android

Class BaasFile

java.lang.Object

com.baasbox.android.BaasObject

com.baasbox.android.BaasFile

All Implemented Interfaces:

android.os.Parcelable

public class BaasFile
extends BaasObject
implements android.os.Parcelable

Represents a BaasBox file.

A file is an entity that can be stored on the server. Unlike documents files do not dictate a format for their content, but they can have optionally json attached data.

Files can be created, stored and retrieved from the server either synchronously or asynchronously, through the provided methods.

A BaasFile does not represent the content of the file, but an handle to the actual content. The actual content can be obtained through a streaming api.

Since:

0.7.3

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<BaasFile>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
BaasFile()
BaasFile(JsonObject attachedData)

Method Summary

Modifier and Type	Method and Description
RequestToken	delete(BaasHandler<java.lang.Void> handler)
RequestToken	delete(int flags, BaasHandler<java.lang.Void> handler)
static RequestToken	delete(java.lang.String id, BaasHandler<java.lang.Void> handler)
static RequestToken	delete(java.lang.String id, int flags, BaasHandler<java.lang.Void> handler)
BaasResult<java.lang.Void>	deleteSync()
static BaasResult<java.lang.Void>	deleteSync(java.lang.String id)
int	describeContents()
RequestToken	download(java.lang.String path, BaasHandler<android.util.Pair<BaasFile,java.lang.String>> handler)
RequestToken	extractedContent(BaasHandler<java.lang.String> handler)
RequestToken	extractedContent(int flags, BaasHandler<java.lang.String> handler)
BaasResult<java.lang.String>	extractedContentSync()
static RequestToken	fetch(java.lang.String id, BaasHandler<BaasFile> handler)
static RequestToken	fetch(java.lang.String id, int flags, BaasHandler<BaasFile> handler)
static RequestToken	fetchAll(BaasHandler<java.util.List<BaasFile>> handler)
static RequestToken	fetchAll(BaasQuery.Criteria filter, BaasHandler<java.util.List<BaasFile>> handler)
static RequestToken	fetchAll(BaasQuery.Criteria filter, int flags, BaasHandler<java.util.List<BaasFile>> handler)
static BaasResult<java.util.List<BaasFile>>	fetchAllSync()
static BaasResult<java.util.List<BaasFile>>	fetchAllSync(BaasQuery.Criteria filter)
static RequestToken	fetchStream(java.lang.String id, BaasHandler<BaasFile> handler)
static BaasResult<BaasFile>	fetchSync(java.lang.String id)
JsonObject	getAttachedData()
java.lang.String	getAuthor() The username of the owner of this object, or null if this object is new.
long	getContentLength()
java.lang.String	getContentType()
java.lang.String	getCreationDate() The date this object was created on the server, or null if the object is new.
byte[]	getData()
java.lang.String	getId() The id of this object on the server.
JsonObject	getMetadata() Retrieves the metadata associated with this file coomputed by the server.
android.net.Uri	getStreamUri()
long	getVersion() The version number of this object.
RequestToken	grant(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to username.
RequestToken	grantAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to users with role.
BaasResult<java.lang.Void>	grantAllSync(Grant grant, java.lang.String role) Synchronously grants the acces grant to this object to all users in role
BaasResult<java.lang.Void>	grantSync(Grant grant, java.lang.String user) Synchronously grants the access grant to this object to username.
boolean	isDirty()
boolean	isDocument()
boolean	isFile()
RequestToken	refresh(BaasHandler<BaasFile> handler)
RequestToken	refresh(int flags, BaasHandler<BaasFile> handler)
BaasResult<BaasFile>	refreshSync()
RequestToken	revoke(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revoke the access grant to this object to username.
RequestToken	revokeAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revokes the access grant to this object from users with role.
BaasResult<java.lang.Void>	revokeAllSync(Grant grant, java.lang.String role) Synchronously revokes the acces grant to this object from all users in role
BaasResult<java.lang.Void>	revokeSync(Grant grant, java.lang.String user) Synchronously revokes the access grant to this object from username.
RequestToken	stream(BaasHandler<BaasFile> handler)
<R> RequestToken	stream(DataStreamHandler<R> contentHandler, BaasHandler<R> handler)
<R> RequestToken	stream(int flags, DataStreamHandler<R> contentHandler, BaasHandler<R> handler)
<R> RequestToken	stream(int sizeId, int flags, DataStreamHandler<R> contentHandler, BaasHandler<R> handler)
static <R> RequestToken	stream(java.lang.String id, DataStreamHandler<R> data, BaasHandler<R> handler)
static <R> RequestToken	stream(java.lang.String id, int flags, DataStreamHandler<R> contentHandler, BaasHandler<R> handler)
BaasResult<BaasStream>	streamImaeSync(int sizeId)
RequestToken	streamImage(int sizeIdx, BaasHandler<BaasFile> handler)
RequestToken	streamImage(java.lang.String sizeSpec, BaasHandler<BaasFile> handler)
static <R> RequestToken	streamImage(java.lang.String id, int size, DataStreamHandler<R> data, BaasHandler<R> handler)
static <R> RequestToken	streamImage(java.lang.String id, int size, int flags, DataStreamHandler<R> data, BaasHandler<R> handler)
BaasResult<BaasStream>	streamImageSync(java.lang.String spec)
static BaasResult<BaasStream>	streamImageSync(java.lang.String id, int sizeId)
static BaasResult<BaasStream>	streamImageSync(java.lang.String id, java.lang.String spec)
BaasResult<BaasStream>	streamSync()
RequestToken	upload(BaasACL acl, byte[] bytes, BaasHandler<BaasFile> handler)
RequestToken	upload(BaasACL acl, byte[] bytes, int flags, BaasHandler<BaasFile> handler)
RequestToken	upload(BaasACL acl, java.io.File file, BaasHandler<BaasFile> handler)
RequestToken	upload(BaasACL acl, java.io.File file, int flags, BaasHandler<BaasFile> handler)
RequestToken	upload(BaasACL acl, java.io.InputStream stream, BaasHandler<BaasFile> handler)
RequestToken	upload(BaasACL acl, java.io.InputStream stream, int flags, BaasHandler<BaasFile> handler)
RequestToken	upload(byte[] bytes, BaasHandler<BaasFile> handler)
RequestToken	upload(byte[] bytes, int flags, BaasHandler<BaasFile> handler)
RequestToken	upload(java.io.File file, BaasHandler<BaasFile> handler)
RequestToken	upload(java.io.File file, int flags, BaasHandler<BaasFile> handler)
RequestToken	upload(java.io.InputStream stream, BaasHandler<BaasFile> handler)
RequestToken	upload(java.io.InputStream stream, int flags, BaasHandler<BaasFile> handler)
BaasResult<BaasFile>	uploadSync(BaasACL acl, byte[] bytes)
BaasResult<BaasFile>	uploadSync(BaasACL acl, java.io.File file)
BaasResult<BaasFile>	uploadSync(BaasACL acl, java.io.InputStream stream)
BaasResult<BaasFile>	uploadSync(byte[] bytes)
BaasResult<BaasFile>	uploadSync(java.io.File file)
BaasResult<BaasFile>	uploadSync(java.io.InputStream stream)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.baasbox.android.BaasObject

asDocument, asFile, grant, grantAll, isNew, revoke, revokeAll

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<BaasFile> CREATOR

Constructor Detail

BaasFile

public BaasFile()

BaasFile

public BaasFile(JsonObject attachedData)

Method Detail

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

isDirty

public boolean isDirty()

Specified by:

isDirty in class BaasObject

fetchAll

public static RequestToken fetchAll(BaasHandler<java.util.List<BaasFile>> handler)

fetchAll

public static RequestToken fetchAll(BaasQuery.Criteria filter,
                                    BaasHandler<java.util.List<BaasFile>> handler)

fetchAll

public static RequestToken fetchAll(BaasQuery.Criteria filter,
                                    int flags,
                                    BaasHandler<java.util.List<BaasFile>> handler)

fetchAllSync

public static BaasResult<java.util.List<BaasFile>> fetchAllSync()

fetchAllSync

public static BaasResult<java.util.List<BaasFile>> fetchAllSync(BaasQuery.Criteria filter)

fetch

public static RequestToken fetch(java.lang.String id,
                                 BaasHandler<BaasFile> handler)

fetch

public static RequestToken fetch(java.lang.String id,
                                 int flags,
                                 BaasHandler<BaasFile> handler)

fetchSync

public static BaasResult<BaasFile> fetchSync(java.lang.String id)

deleteSync

public static BaasResult<java.lang.Void> deleteSync(java.lang.String id)

delete

public static RequestToken delete(java.lang.String id,
                                  BaasHandler<java.lang.Void> handler)

delete

public static RequestToken delete(java.lang.String id,
                                  int flags,
                                  BaasHandler<java.lang.Void> handler)

fetchStream

public static RequestToken fetchStream(java.lang.String id,
                                       BaasHandler<BaasFile> handler)

streamImageSync

public static BaasResult<BaasStream> streamImageSync(java.lang.String id,
                                                     int sizeId)

getStreamUri

public android.net.Uri getStreamUri()

streamImageSync

public static BaasResult<BaasStream> streamImageSync(java.lang.String id,
                                                     java.lang.String spec)

stream

public static <R> RequestToken stream(java.lang.String id,
                                      DataStreamHandler<R> data,
                                      BaasHandler<R> handler)

streamImage

public static <R> RequestToken streamImage(java.lang.String id,
                                           int size,
                                           DataStreamHandler<R> data,
                                           BaasHandler<R> handler)

stream

public static <R> RequestToken stream(java.lang.String id,
                                      int flags,
                                      DataStreamHandler<R> contentHandler,
                                      BaasHandler<R> handler)

streamImage

public static <R> RequestToken streamImage(java.lang.String id,
                                           int size,
                                           int flags,
                                           DataStreamHandler<R> data,
                                           BaasHandler<R> handler)

getAttachedData

public JsonObject getAttachedData()

isFile

public final boolean isFile()

Specified by:

isFile in class BaasObject

isDocument

public final boolean isDocument()

Specified by:

isDocument in class BaasObject

getMetadata

public JsonObject getMetadata()

Retrieves the metadata associated with this file coomputed by the server.

Returns:

an object containing metadata about this file or null if no metadata is found

getAuthor

public java.lang.String getAuthor()

Description copied from class: BaasObject

The username of the owner of this object, or null if this object is new.

Specified by:

getAuthor in class BaasObject

Returns:

a username as String or null

getContentLength

public long getContentLength()

getCreationDate

public java.lang.String getCreationDate()

Description copied from class: BaasObject

The date this object was created on the server, or null if the object is new.

Specified by:

getCreationDate in class BaasObject

Returns:

a string representation of a date.

getId

public java.lang.String getId()

Description copied from class: BaasObject

The id of this object on the server. New objects created locally have no id.

Specified by:

getId in class BaasObject

Returns:

a uuid as a String or null.

getVersion

public long getVersion()

Description copied from class: BaasObject

The version number of this object.

Specified by:

getVersion in class BaasObject

Returns:

a long version number

getContentType

public java.lang.String getContentType()

getData

public byte[] getData()

delete

public RequestToken delete(BaasHandler<java.lang.Void> handler)

delete

public RequestToken delete(int flags,
                           BaasHandler<java.lang.Void> handler)

deleteSync

public BaasResult<java.lang.Void> deleteSync()

grant

public RequestToken grant(Grant grant,
                          java.lang.String username,
                          int flags,
                          BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously grants the access grant to this object to username. The outcome of the request is handed to the provided handler.

Specified by:

grant in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAll

public RequestToken grantAll(Grant grant,
                             java.lang.String role,
                             int flags,
                             BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously grants the access grant to this object to users with role. The outcome of the request is handed to the provided handler.

Specified by:

grantAll in class BaasObject

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAllSync

public BaasResult<java.lang.Void> grantAllSync(Grant grant,
                                               java.lang.String role)

Description copied from class: BaasObject

Synchronously grants the acces grant to this object to all users in role

Specified by:

grantAllSync in class BaasObject

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

grantSync

public BaasResult<java.lang.Void> grantSync(Grant grant,
                                            java.lang.String user)

Description copied from class: BaasObject

Synchronously grants the access grant to this object to username.

Specified by:

grantSync in class BaasObject

Parameters:

grant - a non null Grant

user - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

refresh

public RequestToken refresh(BaasHandler<BaasFile> handler)

refresh

public RequestToken refresh(int flags,
                            BaasHandler<BaasFile> handler)

refreshSync

public BaasResult<BaasFile> refreshSync()

revoke

public RequestToken revoke(Grant grant,
                           java.lang.String username,
                           int flags,
                           BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously revoke the access grant to this object to username. The outcome of the request is handed to the provided handler.

Specified by:

revoke in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAll

public RequestToken revokeAll(Grant grant,
                              java.lang.String role,
                              int flags,
                              BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously revokes the access grant to this object from users with role. The outcome of the request is handed to the provided handler.

Specified by:

revokeAll in class BaasObject

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAllSync

public BaasResult<java.lang.Void> revokeAllSync(Grant grant,
                                                java.lang.String role)

Description copied from class: BaasObject

Synchronously revokes the acces grant to this object from all users in role

Specified by:

revokeAllSync in class BaasObject

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

revokeSync

public BaasResult<java.lang.Void> revokeSync(Grant grant,
                                             java.lang.String user)

Description copied from class: BaasObject

Synchronously revokes the access grant to this object from username.

Specified by:

revokeSync in class BaasObject

Parameters:

grant - a non null Grant

user - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

extractedContent

public RequestToken extractedContent(int flags,
                                     BaasHandler<java.lang.String> handler)

extractedContent

public RequestToken extractedContent(BaasHandler<java.lang.String> handler)

extractedContentSync

public BaasResult<java.lang.String> extractedContentSync()

stream

public RequestToken stream(BaasHandler<BaasFile> handler)

download

public RequestToken download(java.lang.String path,
                             BaasHandler<android.util.Pair<BaasFile,java.lang.String>> handler)

streamImage

public RequestToken streamImage(int sizeIdx,
                                BaasHandler<BaasFile> handler)

streamImage

public RequestToken streamImage(java.lang.String sizeSpec,
                                BaasHandler<BaasFile> handler)

stream

public <R> RequestToken stream(DataStreamHandler<R> contentHandler,
                               BaasHandler<R> handler)

stream

public <R> RequestToken stream(int flags,
                               DataStreamHandler<R> contentHandler,
                               BaasHandler<R> handler)

stream

public <R> RequestToken stream(int sizeId,
                               int flags,
                               DataStreamHandler<R> contentHandler,
                               BaasHandler<R> handler)

streamSync

public BaasResult<BaasStream> streamSync()

streamImageSync

public BaasResult<BaasStream> streamImageSync(java.lang.String spec)

streamImaeSync

public BaasResult<BaasStream> streamImaeSync(int sizeId)

upload

public RequestToken upload(java.io.InputStream stream,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(java.io.File file,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(byte[] bytes,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(java.io.InputStream stream,
                           int flags,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           java.io.InputStream stream,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(java.io.File file,
                           int flags,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           java.io.File file,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(byte[] bytes,
                           int flags,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           byte[] bytes,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           java.io.InputStream stream,
                           int flags,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           java.io.File file,
                           int flags,
                           BaasHandler<BaasFile> handler)

upload

public RequestToken upload(BaasACL acl,
                           byte[] bytes,
                           int flags,
                           BaasHandler<BaasFile> handler)

uploadSync

public BaasResult<BaasFile> uploadSync(java.io.InputStream stream)

uploadSync

public BaasResult<BaasFile> uploadSync(BaasACL acl,
                                       java.io.InputStream stream)

uploadSync

public BaasResult<BaasFile> uploadSync(byte[] bytes)

uploadSync

public BaasResult<BaasFile> uploadSync(BaasACL acl,
                                       byte[] bytes)

uploadSync

public BaasResult<BaasFile> uploadSync(java.io.File file)

uploadSync

public BaasResult<BaasFile> uploadSync(BaasACL acl,
                                       java.io.File file)