com.codename1.cloud

Class CloudStorage

java.lang.Object

com.codename1.cloud.CloudStorage

Deprecated.

this API is targeted for removal due to changes in Google App Engine API support

public class CloudStorage
extends Object

The cloud storage class allows developers to use the Codename One cloud based storage API as a shared database for your application. The database will be visible only to a specific application (based on author/package definitions).
The calls to this class only become effective as a single batch when commit is sent. The commit can be synchronous or asynchronous.
Important due to the nature of the underlying object data store queries can only be performed against an indexed field of which there are 10 hardcoded indexes! Basic data is case sensitive and queries/sort will be performed in a case sensitive way! In order to work around this create a property with an identical name that contains the field as lower or upper case in order to query/sort against.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RETURN_CODE_EMPTY_QUEUE Deprecated. Return code for methods in this class indicating an empty queue
static int	RETURN_CODE_FAIL_OBJECT_MODIFIED Deprecated. Return code for methods in this class indicating a failure due to server side modification of an object (e.g.
static int	RETURN_CODE_FAIL_PERMISSION_VIOLATION Deprecated. Return code for methods in this class indicating a failure due to exceeding server storage quotas
static int	RETURN_CODE_FAIL_QUOTA_EXCEEDED Deprecated. Return code for methods in this class indicating a failure due to exceeding server storage quotas
static int	RETURN_CODE_FAIL_SERVER_ERROR Deprecated. Return code for methods in this class indicating a failure due to generic server side error
static int	RETURN_CODE_SUCCESS Deprecated. Return code for methods in this class indicating a successful operation

Method Summary

Modifier and Type	Method and Description
int	commit() Deprecated. Commit works synchronously and returns one of the return codes above to indicate the status.
void	commit(CloudResponse<Integer> response) Deprecated. A commit version that works asynchronously and returns one of the return codes above to indicate the status.
void	delete(CloudObject cl) Deprecated. Deletes the following object from the cloud storage upon commit
void	deleteAllCloudFilesBefore(long timestamp, String developerAccount, String developerPassword) Deprecated. this API is currently deprecated due to Googles cloud storage deprection
void	deleteAllCloudFilesForUser() Deprecated. this API is currently deprecated due to Googles cloud storage deprection
boolean	deleteCloudFile(String fileId) Deprecated. this API is currently deprecated due to Googles cloud storage deprection
CloudObject[]	fetch(String[] cloudIds) Deprecated. Fetches the objects from the server.
void	fetch(String[] cloudIds, CloudResponse<CloudObject[]> response) Deprecated. Fetches the objects from the server asynchronously.
static CloudStorage	getInstance() Deprecated. Creates an instance of the cloud storage object, only one instance should be used per application.
String	getUrlForCloudFileId(String fileId) Deprecated. this API is currently deprecated due to Googles cloud storage deprection
CloudObject[]	queryEquals(String type, int index, String value, int page, int limit, int visibilityScope) Deprecated. Performs a query to the server finding the objects where the key value is equal to the given value.
void	queryEquals(String type, int index, String value, int page, int limit, int visibilityScope, CloudResponse<CloudObject[]> response) Deprecated. Performs a query to the server finding the objects where the key value is equal to the given value.
int	queryEqualsCount(String type, int index, String value, int visibilityScope) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
void	queryEqualsCount(String type, int index, String value, int visibilityScope, CloudResponse<Integer> response) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
String[]	queryEqualsKeys(String type, int index, String value, int page, int limit, int visibilityScope) Deprecated. Equivalent to the standard query but just returns the keys matching the given query
void	queryEqualsKeys(String type, int index, String value, int page, int limit, int visibilityScope, CloudResponse<String[]> response) Deprecated. Equivalent to the standard query but just returns the keys matching the given query
CloudObject[]	queryGreaterThan(String type, int index, String value, int page, int limit, int visibilityScope) Deprecated. Performs a query to the server finding the objects where the key value is greater than the given value.
void	queryGreaterThan(String type, int index, String value, int page, int limit, int visibilityScope, CloudResponse<CloudObject[]> response) Deprecated. Performs a query to the server finding the objects where the key value is greater than the given value.
int	queryGreaterThanCount(String type, int index, String value, int visibilityScope) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
void	queryGreaterThanCount(String type, int index, String value, int visibilityScope, CloudResponse<Integer> response) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
CloudObject[]	queryLessThan(String type, int index, String value, int page, int limit, int visibilityScope) Deprecated. Performs a query to the server finding the objects where the key value is smaller than the given value.
void	queryLessThan(String type, int index, String value, int page, int limit, int visibilityScope, CloudResponse<CloudObject[]> response) Deprecated. Performs a query to the server finding the objects where the key value is smaller than the given value.
int	queryLessThanCount(String type, int index, String value, int visibilityScope) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
void	queryLessThanCount(String type, int index, String value, int visibilityScope, CloudResponse<Integer> response) Deprecated. Equivalent to the standard query but just returns the total count of entries that will be returned
CloudObject[]	querySorted(String type, int index, boolean ascending, int page, int limit, int visibilityScope) Deprecated. Performs a query to the server finding the objects where the sort is equal to the given value.
void	querySorted(String type, int index, boolean ascending, int page, int limit, int visibilityScope, CloudResponse<CloudObject[]> response) Deprecated. Performs a query to the server finding the objects where the sort is equal to the given value.
String[]	querySortedKeys(String type, int index, boolean ascending, int page, int limit, int visibilityScope) Deprecated. Performs a query to the server finding the objects where the sort is equal to the given value and returning the cloud key of these objects.
void	querySortedKeys(String type, int index, boolean ascending, int page, int limit, int visibilityScope, CloudResponse<String[]> response) Deprecated. Performs a query to the server finding the objects where the sort is equal to the given value and returning the cloud key of these objects.
int	refresh(CloudObject[] objects) Deprecated. this feature is no longer supported
void	refresh(CloudObject[] objects, CloudResponse<Integer> response) Deprecated. Refresh the given objects with data from the server if they were modified on the server (this is the asynchronous version of the method).
void	refreshAsync(CloudObject obj) Deprecated. Adds the given object to a set of refresh operations in which we don't really care if the operation is successful
void	rollback() Deprecated. Cancels current pending changes
void	save(CloudObject object) Deprecated. Adds the given object to the save queue, the operation will only take place once committed
String	uploadCloudFile(String mimeType, String file) Deprecated. this API is currently deprecated due to Googles cloud storage deprection
String	uploadCloudFile(String mimeType, String filename, InputStream data, int dataSize) Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Methods inherited from class java.lang.Object

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

Field Detail

RETURN_CODE_SUCCESS

public static final int RETURN_CODE_SUCCESS

Deprecated.

Return code for methods in this class indicating a successful operation

See Also:

Constant Field Values

RETURN_CODE_FAIL_OBJECT_MODIFIED

public static final int RETURN_CODE_FAIL_OBJECT_MODIFIED

Deprecated.

Return code for methods in this class indicating a failure due to server side modification of an object (e.g. different user changed the object)

See Also:

Constant Field Values

RETURN_CODE_FAIL_SERVER_ERROR

public static final int RETURN_CODE_FAIL_SERVER_ERROR

Deprecated.

Return code for methods in this class indicating a failure due to generic server side error

See Also:

Constant Field Values

RETURN_CODE_FAIL_QUOTA_EXCEEDED

public static final int RETURN_CODE_FAIL_QUOTA_EXCEEDED

Deprecated.

Return code for methods in this class indicating a failure due to exceeding server storage quotas

See Also:

Constant Field Values

RETURN_CODE_EMPTY_QUEUE

public static final int RETURN_CODE_EMPTY_QUEUE

Deprecated.

Return code for methods in this class indicating an empty queue

See Also:

Constant Field Values

RETURN_CODE_FAIL_PERMISSION_VIOLATION

public static final int RETURN_CODE_FAIL_PERMISSION_VIOLATION

Deprecated.

Return code for methods in this class indicating a failure due to exceeding server storage quotas

See Also:

Constant Field Values

Method Detail

getInstance

public static CloudStorage getInstance()

Deprecated.

Creates an instance of the cloud storage object, only one instance should be used per application. This method is important since it may block to complete/cleanup a previous transaction that wasn't fully completed before exiting the application.

Returns:

the instance of the class

save

public void save(CloudObject object)

Deprecated.

Adds the given object to the save queue, the operation will only take place once committed

Parameters:

object - the object to save into the cloud, new objects are inserted. existing objects are updated

delete

public void delete(CloudObject cl)

Deprecated.

Deletes the following object from the cloud storage upon commit

Parameters:

cl - the cloud object to delete

refresh

public void refresh(CloudObject[] objects,
                    CloudResponse<Integer> response)

Deprecated.

Refresh the given objects with data from the server if they were modified on the server (this is the asynchronous version of the method). This operation executes immeditely without waiting for commit.

Parameters:

objects - objects to refresh

response - object for the response

refreshAsync

public void refreshAsync(CloudObject obj)

Deprecated.

Adds the given object to a set of refresh operations in which we don't really care if the operation is successful

Parameters:

obj - the object to refresh

refresh

public int refresh(CloudObject[] objects)

Deprecated. this feature is no longer supported

Refresh the given objects with data from the server if they were modified on the server. This operation executes immeditely without waiting for commit.

Parameters:

objects - objects to refresh

Returns:

status code matching the situation, one of: RETURN_CODE_SUCCESS, RETURN_CODE_FAIL_SERVER_ERROR

fetch

public CloudObject[] fetch(String[] cloudIds)
                    throws CloudException

Deprecated.

Fetches the objects from the server. This operation executes immediately without waiting for commit.

Parameters:

cloudIds - the object id's to fetch

Returns:

the cloud objects or null if a server error occurred

Throws:

CloudException - thrown for a server side/connection error

fetch

public void fetch(String[] cloudIds,
                  CloudResponse<CloudObject[]> response)

Deprecated.

Fetches the objects from the server asynchronously. This operation executes immeditely without waiting for commit.

Parameters:

cloudIds - the object id's to fetch

response - returns the response from the server

queryEquals

public CloudObject[] queryEquals(String type,
                                 int index,
                                 String value,
                                 int page,
                                 int limit,
                                 int visibilityScope)
                          throws CloudException

Deprecated.

Performs a query to the server finding the objects where the key value is equal to the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

array of objects matching the query

Throws:

CloudException - thrown for a server side/connection error

querySorted

public CloudObject[] querySorted(String type,
                                 int index,
                                 boolean ascending,
                                 int page,
                                 int limit,
                                 int visibilityScope)
                          throws CloudException

Deprecated.

Performs a query to the server finding the objects where the sort is equal to the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index on which the sort is based

ascending - indicates if the sort order is ascending or descending

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

array of objects matching the query

Throws:

CloudException - thrown for a server side/connection error

querySortedKeys

public String[] querySortedKeys(String type,
                                int index,
                                boolean ascending,
                                int page,
                                int limit,
                                int visibilityScope)
                         throws CloudException

Deprecated.

Performs a query to the server finding the objects where the sort is equal to the given value and returning the cloud key of these objects. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index on which the sort is based

ascending - indicates if the sort order is ascending or descending

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

the keys for the cloud objects matching the query

Throws:

CloudException - thrown for a server side/connection error

queryEqualsKeys

public String[] queryEqualsKeys(String type,
                                int index,
                                String value,
                                int page,
                                int limit,
                                int visibilityScope)
                         throws CloudException

Deprecated.

Equivalent to the standard query but just returns the keys matching the given query

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

the keys for the cloud objects matching the query

Throws:

CloudException - thrown for a server side/connection error

queryEqualsCount

public int queryEqualsCount(String type,
                            int index,
                            String value,
                            int visibilityScope)
                     throws CloudException

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

the number of elements

Throws:

CloudException - thrown for a server side/connection error

queryGreaterThanCount

public int queryGreaterThanCount(String type,
                                 int index,
                                 String value,
                                 int visibilityScope)
                          throws CloudException

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

the number of elements

Throws:

CloudException - thrown for a server side/connection error

queryLessThanCount

public int queryLessThanCount(String type,
                              int index,
                              String value,
                              int visibilityScope)
                       throws CloudException

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

the number of elements

Throws:

CloudException - thrown for a server side/connection error

queryGreaterThan

public CloudObject[] queryGreaterThan(String type,
                                      int index,
                                      String value,
                                      int page,
                                      int limit,
                                      int visibilityScope)
                               throws CloudException

Deprecated.

Performs a query to the server finding the objects where the key value is greater than the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

array of objects matching the query

Throws:

CloudException - thrown for a server side/connection error

queryLessThan

public CloudObject[] queryLessThan(String type,
                                   int index,
                                   String value,
                                   int page,
                                   int limit,
                                   int visibilityScope)
                            throws CloudException

Deprecated.

Performs a query to the server finding the objects where the key value is smaller than the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

Returns:

array of objects matching the query

Throws:

CloudException - thrown for a server side/connection error

querySorted

public void querySorted(String type,
                        int index,
                        boolean ascending,
                        int page,
                        int limit,
                        int visibilityScope,
                        CloudResponse<CloudObject[]> response)

Deprecated.

Performs a query to the server finding the objects where the sort is equal to the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index on which the sort is based

ascending - indicates if the sort order is ascending or descending

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryEquals

public void queryEquals(String type,
                        int index,
                        String value,
                        int page,
                        int limit,
                        int visibilityScope,
                        CloudResponse<CloudObject[]> response)

Deprecated.

Performs a query to the server finding the objects where the key value is equal to the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryEqualsCount

public void queryEqualsCount(String type,
                             int index,
                             String value,
                             int visibilityScope,
                             CloudResponse<Integer> response)

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryGreaterThanCount

public void queryGreaterThanCount(String type,
                                  int index,
                                  String value,
                                  int visibilityScope,
                                  CloudResponse<Integer> response)

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

querySortedKeys

public void querySortedKeys(String type,
                            int index,
                            boolean ascending,
                            int page,
                            int limit,
                            int visibilityScope,
                            CloudResponse<String[]> response)

Deprecated.

Performs a query to the server finding the objects where the sort is equal to the given value and returning the cloud key of these objects. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index on which the sort is based

ascending - indicates if the sort order is ascending or descending

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryEqualsKeys

public void queryEqualsKeys(String type,
                            int index,
                            String value,
                            int page,
                            int limit,
                            int visibilityScope,
                            CloudResponse<String[]> response)

Deprecated.

Equivalent to the standard query but just returns the keys matching the given query

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryLessThanCount

public void queryLessThanCount(String type,
                               int index,
                               String value,
                               int visibilityScope,
                               CloudResponse<Integer> response)

Deprecated.

Equivalent to the standard query but just returns the total count of entries that will be returned

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryGreaterThan

public void queryGreaterThan(String type,
                             int index,
                             String value,
                             int page,
                             int limit,
                             int visibilityScope,
                             CloudResponse<CloudObject[]> response)

Deprecated.

Performs a query to the server finding the objects where the key value is greater than the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

queryLessThan

public void queryLessThan(String type,
                          int index,
                          String value,
                          int page,
                          int limit,
                          int visibilityScope,
                          CloudResponse<CloudObject[]> response)

Deprecated.

Performs a query to the server finding the objects where the key value is smaller than the given value. This operation executes immeditely without waiting for commit.

Parameters:

type - the object type

index - the index to query for the given value

value - the value of said index to include in the response object

page - the page of responses (allows for paging)

limit - number of responses to fetch

visibilityScope - indicates the scope in which to look as one of the CloudObject constants ACCESS_*

response - array of objects matching the query

uploadCloudFile

public String uploadCloudFile(String mimeType,
                              String file)
                       throws CloudException,
                              IOException

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Allows uploading of images etc. to the cloud which can later on be referenced as URL's.

Parameters:

mimeType - the mimetype of the uploaded file

file - the URL of the local file

Returns:

an ID for the given file that can be used to delete the file or construct a URL of the file

Throws:

CloudException - in case of a server side error

IOException - when a problem occurs with the file

uploadCloudFile

public String uploadCloudFile(String mimeType,
                              String filename,
                              InputStream data,
                              int dataSize)
                       throws CloudException,
                              IOException

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Allows uploading of images etc. to the cloud which can later on be referenced as URL's.

Parameters:

mimeType - the mimetype of the uploaded file

filename - a short name for the file uploaded (not a full path)

data - input stream from which to read the file

dataSize - the size in bytes of the input stream (this is essential for file upload to work on all devices!)

Returns:

an ID for the given file that can be used to delete the file or construct a URL of the file

Throws:

CloudException - in case of a server side error

IOException - when a problem occurs with the file

deleteCloudFile

public boolean deleteCloudFile(String fileId)

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Deletes a file from the cloud storage

Parameters:

fileId - the file id to delete

Returns:

true if the operation was successful

deleteAllCloudFilesForUser

public void deleteAllCloudFilesForUser()

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Deletes all the cloud files under this user, notice that this method is asynchronous and a background server process performs the actual deletion

deleteAllCloudFilesBefore

public void deleteAllCloudFilesBefore(long timestamp,
                                      String developerAccount,
                                      String developerPassword)

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Deletes all the cloud files before the given time stamp for the given development account. Notice that this method is meant for internal use and not for distributable apps since it includes your developer account. This method works in a background server process and returns immediately.

Parameters:

timestamp - the timestamp since epoch (as in System.currentTimemillis).

developerAccount - your developer email

developerPassword - your developer password

getUrlForCloudFileId

public String getUrlForCloudFileId(String fileId)

Deprecated. this API is currently deprecated due to Googles cloud storage deprection

Converts a file id to a URL with which the file can be downloaded, notice that the file URL is world readable!

Parameters:

fileId - the file ID

Returns:

a URL that allows downloading the file

commit

public int commit()

Deprecated.

Commit works synchronously and returns one of the return codes above to indicate the status.

Returns:

status code from the constants in this class

commit

public void commit(CloudResponse<Integer> response)

Deprecated.

A commit version that works asynchronously and returns one of the return codes above to indicate the status.

Parameters:

response - response code with status code from the constants in this class

rollback

public void rollback()

Deprecated.

Cancels current pending changes