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 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> RemoteObservableList<T>	retrieveList(java.lang.String id, java.lang.Class<T> objectClass) Retrieve the list with the provided id.
<T> RemoteObservableList<T>	retrieveList(java.lang.String id, java.lang.Class<T> objectClass, SyncFlag... flags) Retrieve the list with the provided id, using the provided flags to decide how the list will be synchronized with Gluon Cloud.
<T> void	retrieveObject(java.lang.String id, java.lang.Class<T> objectClass, java.util.function.BiConsumer<javafx.concurrent.Worker.State,T> consumer) Retrieve the object with the provided id.
<T> void	storeObject(java.lang.String id, T object) Store the provided object with the given id.

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> RemoteObservableList<T> retrieveList(java.lang.String id,
                                                java.lang.Class<T> objectClass)

Retrieve the list with the provided id. When the list does not yet exist on Gluon Cloud, an empty list will be created instead. By default, changes (additions and removals) that are made to the returned RemoteObservableList instance will be synchronized to Gluon Cloud. Use retrieveList(java.lang.String, java.lang.Class, com.gluonhq.charm.connect.service.SyncFlag...) in case other synchronization parameters need to be specified.

Type Parameters:

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

Parameters:

id - The id of the list.

objectClass - The class of the elements in the list.

Returns:

An instance of RemoteObservableList that will hold the items of the list on Gluon Cloud.

retrieveList

public <T> RemoteObservableList<T> retrieveList(java.lang.String id,
                                                java.lang.Class<T> objectClass,
                                                SyncFlag... flags)

Retrieve the list with the provided id, using the provided flags to decide how the list will be synchronized with Gluon Cloud. When the list does not yet exist on Gluon Cloud, an empty list will be created instead.

Type Parameters:

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

Parameters:

id - The id of the list.

objectClass - The class of the elements in the list.

flags - define how changes between the local and remote list are reflected to each other.

Returns:

An instance of RemoteObservableList that will hold the items of the list on Gluon Cloud.

storeObject

public <T> void storeObject(java.lang.String id,
                            T object)

Store the provided object with the given id.

Type Parameters:

T - The type of the object.

Parameters:

id - The id of the object.

object - The actual object to store.

retrieveObject

public <T> void retrieveObject(java.lang.String id,
                               java.lang.Class<T> objectClass,
                               java.util.function.BiConsumer<javafx.concurrent.Worker.State,T> consumer)

Retrieve the object with the provided id. The retrieval occurs in the background by using a Worker. The provided consumer will be called whenever the state of the background worker changes. When the state is equal to SUCCEEDED, it is safe to process the second parameter of the consumer as well. Please note, that it's still possible that the second parameter will be null, for instance when no object with the provided id exists.

Type Parameters:

T - The type of the object to retrieve.

Parameters:

id - The id of the object to retrieve.

objectClass - The class of the object to retrieve.

consumer - BiConsumer function that will be called whenever the state of the background worker changes.