io.cloudboost

Class CloudFile

java.lang.Object

io.cloudboost.CloudFile

public class CloudFile
extends Object

Title: Abstract wrapper for File objects

CloudFile is an object that represents an arbitrary file format, can save and retrieve these from CloudBoost

Author:

cloudboost

Constructor Summary

Constructors

Constructor and Description
CloudFile(Blob fileObj) Constructor that builds CloudFile Object from a Blob
CloudFile(File fileObj) Constructor that builds a CloudFile object from File and tries to guess the mimetype
CloudFile(File fileObj, String contentType) Constructor that builds a CloudFile object from File and content type of the file
CloudFile(JSONObject jsonObject)
CloudFile(String url) A Constructor that takes the URL of a file and downloads it to create a CloudFile Object
CloudFile(String fileName, Object data, String type) Constructor that builds a CloudFile object out of arbitrary data

Method Summary

Modifier and Type	Method and Description
void	delete(CloudStringCallback callbackObject) deletes a saved CloudFile
void	fetch(CloudFileArrayCallback callback) fetches this file from the database
ACL	getAcl() returns the ACL object representing the access rights on this file
JSONObject	getDocument() returns the raw JSONObject wrapped by this class, only make direct changes to the underlying JSONObject if you absolutely know what you are doing
void	getFileContent(ObjectCallback callback) returns the file content as an object
String	getFileName() returns the name of the file
int	getFileSize() Returns the size of the file in Bytes
String	getFileType() returns the mime type of the file as a String
String	getFileUrl() returns the URL of the file as saved in cloudboost, unsaved files have no URL's
String	getId() returns the Id assigned to this file after saving, an unsaved CloudFile object has no Id
static void	main(String[] args)
void	save(CloudFileCallback callbackObject) Makes an HTTP POST request to upload the file and save all attributes to CloudBoost
void	save(CloudFileCallback callbackObject, FileUploadCallback uploadCallback) Makes an HTTP POST request to upload the file and save all attributes to CloudBoost
void	setAcl(ACL acl) replaces the existing ACL object
void	setDocument(JSONObject document)
void	setFileName(String name) Gives the file a name as should be saved in CloudBoost
void	setFileType(String type) Changes the type of the file to the given String

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudFile

public CloudFile(File fileObj,
                 String contentType)
          throws CloudException

Constructor that builds a CloudFile object from File and content type of the file

Parameters:

fileObj - a Java file object

contentType - String representing content/mime type of this file

Throws:

CloudException

CloudFile

public CloudFile(File fileObj)
          throws CloudException

Constructor that builds a CloudFile object from File and tries to guess the mimetype

Parameters:

fileObj - a java file object

Throws:

CloudException

CloudFile

public CloudFile(Blob fileObj)
          throws CloudException

Constructor that builds CloudFile Object from a Blob

Parameters:

fileObj -

Throws:

CloudException

CloudFile

public CloudFile(String url)
          throws CloudException

A Constructor that takes the URL of a file and downloads it to create a CloudFile Object

Parameters:

url -

Throws:

CloudException

CloudFile

public CloudFile(String fileName,
                 Object data,
                 String type)
          throws CloudException

Constructor that builds a CloudFile object out of arbitrary data

Parameters:

fileName - the name under which the file should be stored

data - the content of the file

type - mimetype of the file

Throws:

CloudException

CloudFile

public CloudFile(JSONObject jsonObject)

Method Detail

setDocument

public void setDocument(JSONObject document)

getId

public String getId()

returns the Id assigned to this file after saving, an unsaved CloudFile object has no Id

Returns:

_id

setFileType

public void setFileType(String type)

Changes the type of the file to the given String

Parameters:

type - mime type of file

getFileType

public String getFileType()

returns the mime type of the file as a String

Returns:

fileType

getFileUrl

public String getFileUrl()

returns the URL of the file as saved in cloudboost, unsaved files have no URL's

Returns:

file url

setFileName

public void setFileName(String name)

Gives the file a name as should be saved in CloudBoost

Parameters:

name - the name the file should be saved under

getFileName

public String getFileName()

returns the name of the file

Returns:

fileName

getFileSize

public int getFileSize()

Returns the size of the file in Bytes

Returns:

size

save

public void save(CloudFileCallback callbackObject,
                 FileUploadCallback uploadCallback)
          throws CloudException,
                 IOException,
                 JSONException

Makes an HTTP POST request to upload the file and save all attributes to CloudBoost

Parameters:

callbackObject - callback to be triggered when the call has completed

uploadCallback - callback interface that returns in realtime the percent of file uploaded

Throws:

CloudException

IOException

JSONException

save

public void save(CloudFileCallback callbackObject)
          throws CloudException,
                 IOException,
                 JSONException

Makes an HTTP POST request to upload the file and save all attributes to CloudBoost

Parameters:

callbackObject - callback to be triggered when the call has completed

Throws:

CloudException

IOException

JSONException

getDocument

public JSONObject getDocument()

returns the raw JSONObject wrapped by this class, only make direct changes to the underlying JSONObject if you absolutely know what you are doing

Returns:

document

delete

public void delete(CloudStringCallback callbackObject)
            throws CloudException

deletes a saved CloudFile

Parameters:

callbackObject - callback triggered when the call completes

Throws:

CloudException

getFileContent

public void getFileContent(ObjectCallback callback)

returns the file content as an object

Parameters:

callback -

getAcl

public ACL getAcl()

returns the ACL object representing the access rights on this file

Returns:

setAcl

public void setAcl(ACL acl)

replaces the existing ACL object

Parameters:

acl - new ACL object

fetch

public void fetch(CloudFileArrayCallback callback)
           throws CloudException

fetches this file from the database

Parameters:

callback -

Throws:

CloudException

main

public static void main(String[] args)
                 throws CloudException,
                        JSONException,
                        IOException

Throws:

CloudException

JSONException

IOException