com.gluonhq.charm.connect.service

Class StorageService

java.lang.Object

com.gluonhq.charm.connect.service.CharmService

com.gluonhq.charm.connect.service.StorageService

public class StorageService
extends CharmService

The StorageService provides methods to access the application data that is stored on the device or in Gluon Cloud.

Field Summary

Fields inherited from class com.gluonhq.charm.connect.service.CharmService

gluonClient

Constructor Summary

Constructors

Constructor and Description
StorageService(GluonClient gluonClient) Construct a new StorageService.

Method Summary

Modifier and Type	Method and Description
StorageService	authentication(Authentication authentication) Defines which authentication method must be used when retrieving data from Gluon Cloud.
<T> CharmObservableList<T>	retrieveList(java.lang.String listIdentifier, java.lang.Class<T> objectClass) Retrieve the list with the provided id from the device storage system.
<T> CharmObservableList<T>	retrieveList(java.lang.String listIdentifier, java.lang.Class<T> objectClass, StorageWhere storageWhere) Retrieve the list with the provided id from the provided storage system.
<T> CharmObservableList<T>	retrieveList(java.lang.String listIdentifier, java.lang.Class<T> objectClass, StorageWhere storageWhere, SyncFlag... syncFlags) Retrieve the list with the provided id, from the provided storage system using the provided synchronization flags to decide how the list will be synchronized with the chosen storage system.
<T> CharmObservableObject<T>	retrieveObject(java.lang.String objectIdentifier, java.lang.Class<T> objectClass) Retrieve the object with the provided id from the device storage system.
<T> CharmObservableObject<T>	retrieveObject(java.lang.String objectIdentifier, java.lang.Class<T> objectClass, StorageWhere storageWhere) Retrieve the object with the provided id from the provided storage system.
<T> CharmObservableObject<T>	retrieveObject(java.lang.String objectIdentifier, java.lang.Class<T> objectClass, StorageWhere storageWhere, SyncFlag... syncFlags) Retrieve the object with the provided id from the provided storage system, using the provided flags to decide how the object will be synchronized with the storage system.
<T> CharmObservableObject<T>	storeObject(java.lang.String objectIdentifier, T object) Store the provided object with the given identifier on the device storage system.
<T> CharmObservableObject<T>	storeObject(java.lang.String objectIdentifier, T object, StorageWhere storageWhere) Store the provided object with the given id at the specified storage system.
<T> CharmObservableObject<T>	storeObject(java.lang.String objectIdentifier, T object, StorageWhere storageWhere, SyncFlag... syncFlags) Store the provided object with the given id at the specified storage system, using the provided synchronization flags to decide how the object will be synchronized with the storage system.

Methods inherited from class com.gluonhq.charm.connect.service.CharmService

getGluonClient

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageService

public StorageService(GluonClient gluonClient)

Construct a new StorageService.

Parameters:

gluonClient - The GluonClient instance used to connect with Gluon Cloud.

Method Detail

authentication

public StorageService authentication(Authentication authentication)

Defines which authentication method must be used when retrieving data from Gluon Cloud.

Parameters:

authentication - The authentication method to use.

Returns:

This instance of the StorageService.

retrieveList

public <T> CharmObservableList<T> retrieveList(java.lang.String listIdentifier,
                                               java.lang.Class<T> objectClass)

Retrieve the list with the provided id from the device storage system. When the list does not yet exist, an empty list will be created instead. By default, changes (additions and removals) that are made to the returned CharmObservableList instance will be synchronized directly to the storage on the device. Use retrieveList(String, Class, StorageWhere, SyncFlag...) in case other synchronization parameters are needed.

Type Parameters:

T - The type of the elements that are contained in the list.

Parameters:

listIdentifier - The unique identifier of the list.

objectClass - The class of the elements in the list.

Returns:

An instance of CharmObservableList that will hold the items of the list on the device storage.

retrieveList

public <T> CharmObservableList<T> retrieveList(java.lang.String listIdentifier,
                                               java.lang.Class<T> objectClass,
                                               StorageWhere storageWhere)

Retrieve the list with the provided id from the provided storage system. When the list does not yet exist, an empty list will be created instead. By default, changes (additions and removals) that are made to the returned CharmObservableList instance will be synchronized to the storage location. Use retrieveList(String, Class, StorageWhere, SyncFlag...) in case other synchronization parameters are needed.

Type Parameters:

T - The type of the elements that are contained in the list.

Parameters:

listIdentifier - The unique identifier of the list.

objectClass - The class of the elements in the list.

storageWhere - The storage system to use for storing and retrieving the items of the list.

Returns:

An instance of CharmObservableList that will hold the items of the list on the specified storage system.

retrieveList

public <T> CharmObservableList<T> retrieveList(java.lang.String listIdentifier,
                                               java.lang.Class<T> objectClass,
                                               StorageWhere storageWhere,
                                               SyncFlag... syncFlags)

Retrieve the list with the provided id, from the provided storage system using the provided synchronization flags to decide how the list will be synchronized with the chosen storage system. When the list does not yet exist, an empty list will be created instead.

Type Parameters:

T - The type of the elements that are contained in the list.

Parameters:

listIdentifier - The unique identifier of the list.

objectClass - The class of the elements in the list.

storageWhere - The storage system to use for storing and retrieving the items of the list.

syncFlags - Synchronization flags that define how changes between the local list and the stored list are reflected to each other.

Returns:

An instance of CharmObservableList that will hold the items of the list on the specified storage system.

storeObject

public <T> CharmObservableObject<T> storeObject(java.lang.String objectIdentifier,
                                                T object)

Store the provided object with the given identifier on the device storage system.

Type Parameters:

T - The type of the object.

Parameters:

objectIdentifier - The unique identifier of the object.

object - The actual object to store.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.

storeObject

public <T> CharmObservableObject<T> storeObject(java.lang.String objectIdentifier,
                                                T object,
                                                StorageWhere storageWhere)

Store the provided object with the given id at the specified storage system.

Type Parameters:

T - The type of the object.

Parameters:

objectIdentifier - The unique identifier of the object.

object - The actual object to store.

storageWhere - The storage system to use for storing the object.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.

storeObject

public <T> CharmObservableObject<T> storeObject(java.lang.String objectIdentifier,
                                                T object,
                                                StorageWhere storageWhere,
                                                SyncFlag... syncFlags)

Store the provided object with the given id at the specified storage system, using the provided synchronization flags to decide how the object will be synchronized with the storage system.

Type Parameters:

T - The type of the object.

Parameters:

objectIdentifier - The unique identifier of the object.

object - The actual object to store.

storageWhere - The storage system to use for storing the object.

syncFlags - Synchronization flags that define how changes between the local object and the stored object are reflected to each other.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.

retrieveObject

public <T> CharmObservableObject<T> retrieveObject(java.lang.String objectIdentifier,
                                                   java.lang.Class<T> objectClass)

Retrieve the object with the provided id from the device storage system.

Type Parameters:

T - The type of the object to retrieve.

Parameters:

objectIdentifier - The unique identifier of the object to retrieve.

objectClass - The class of the object to retrieve.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.

retrieveObject

public <T> CharmObservableObject<T> retrieveObject(java.lang.String objectIdentifier,
                                                   java.lang.Class<T> objectClass,
                                                   StorageWhere storageWhere)

Retrieve the object with the provided id from the provided storage system.

Type Parameters:

T - The type of the object to retrieve.

Parameters:

objectIdentifier - The unique identifier of the object to retrieve.

objectClass - The class of the object to retrieve.

storageWhere - The storage system to use for storing and retrieving the object.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.

retrieveObject

public <T> CharmObservableObject<T> retrieveObject(java.lang.String objectIdentifier,
                                                   java.lang.Class<T> objectClass,
                                                   StorageWhere storageWhere,
                                                   SyncFlag... syncFlags)

Retrieve the object with the provided id from the provided storage system, using the provided flags to decide how the object will be synchronized with the storage system.

Type Parameters:

T - The type of the object to retrieve.

Parameters:

objectIdentifier - The unique identifier of the object to retrieve.

objectClass - The class of the object to retrieve.

storageWhere - The storage system to use for storing and retrieving the object.

syncFlags - Synchronization flags that define how changes between the local object and the stored object are reflected to each other.

Returns:

An instance of CharmObservableObject that will hold a reference to the stored object.