GluonClient (connect 1.1.0 API)

java.lang.Object
- com.gluonhq.connect.gluoncloud.GluonClient

public class GluonClient
extends java.lang.Object

The GluonClient is the access point to the Gluon CloudLink infrastructure. It assists in using the DataProvider with data stored on Gluon CloudLink as the data source. For instance, to retrieve a list from Gluon CloudLink, you can use the following code:

     GluonClient gluonClient = GluonClientBuilder.create()
             .credentials(new GluonCredentials(APP_KEY, APP_SECRET))
             .build();

     GluonObservableList<Item> items = DataProvider.retrieveList(gluonClient.createListDataReader("items", Item.class));

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ReadOnlyObjectProperty<User>`	`authenticatedUser` A property that holds the currently authenticated user.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<V> void`	`authenticate(java.util.concurrent.Callable<V> callable)` Start the authentication flow.
`<O> void`	`authenticate(java.util.function.Consumer<O> consumer, O acceptable)` Start the authentication flow.
`void`	`authenticate(java.lang.Runnable runnable)` Start the authentication flow.
`javafx.beans.property.ReadOnlyObjectProperty<User>`	`authenticatedUserProperty()` A property that holds the currently authenticated user.
`<E> ListDataReader<E>`	`createListDataReader(java.lang.String identifier, java.lang.Class<E> objectClass)` Creates an instance of `ListDataReader` that can be passed directly in the `DataProvider.retrieveList(ListDataReader)` method.
`<E> ListDataReader<E>`	`createListDataReader(java.lang.String identifier, java.lang.Class<E> objectClass, SyncFlag... syncFlags)` Creates an instance of `ListDataReader` that can be passed directly in the `DataProvider.retrieveList(ListDataReader)` method.
`<T> ObjectDataReader<T>`	`createObjectDataReader(java.lang.String identifier, java.lang.Class<T> objectClass, SyncFlag... syncFlags)` Creates an instance of `ObjectDataReader` that can be passed directly in the `DataProvider.retrieveObject(ObjectDataReader)` method.
`<T> ObjectDataRemover<T>`	`createObjectDataRemover()` Creates an instance of `ObjectDataRemover` that can be passed directly in the `DataProvider.removeObject(GluonObservableObject, ObjectDataRemover)` method.
`<T> ObjectDataWriter<T>`	`createObjectDataWriter(java.lang.String identifier, java.lang.Class<T> objectClass, SyncFlag... syncFlags)` Creates an instance of `ObjectDataWriter` that can be passed directly in the `DataProvider.storeObject(Object, ObjectDataWriter)` method.
`User`	`getAuthenticatedUser()` Gets the value of the property authenticatedUser.
`AuthenticationMode`	`getAuthenticationMode()` Get the authentication mode to use when storing or retrieving data with this GluonClient instance.
`GluonCredentials`	`getCredentials()` Get the application credentials that are used to authorize the application when connecting with Gluon CloudLink.
`java.lang.String`	`getHost()` Get the name of the host that is used for connecting to Gluon CloudLink.
`OperationMode`	`getOperationMode()` Get the operation mode to use when storing or retrieving data with this GluonClient instance.
`boolean`	`isAuthenticated()` Check whether the application is successfully authenticated with a user.
`<E> void`	`push(GluonObservableList<E> list)` Push any changes made to the list to Gluon CloudLink.
`<E> void`	`push(GluonObservableList<E> list, boolean fully)` Push any changes made to the list to Gluon CloudLink.
`<T> void`	`push(GluonObservableObject<T> object)` Push any changes made to the object to Gluon CloudLink.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - authenticatedUser
```
public javafx.beans.property.ReadOnlyObjectProperty<User> authenticatedUserProperty
```
    A property that holds the currently authenticated user. The property can contain a null value if no user is currently authenticated.
    
    See Also:
    
    getAuthenticatedUser()
- Method Detail
  - getHost
```
public java.lang.String getHost()
```
    Get the name of the host that is used for connecting to Gluon CloudLink. The host name will in most cases refer to the online Gluon CloudLink infrastructure. It will mostly only be different when running Gluon CloudLink in an on premise environment.
    
    Returns:
    
    the name of the host of Gluon CloudLink
  - getCredentials
```
public GluonCredentials getCredentials()
```
    Get the application credentials that are used to authorize the application when connecting with Gluon CloudLink.
    
    Returns:
    
    the credentials used for authorizing the application when connecting with Gluon CloudLink.
  - getAuthenticationMode
```
public AuthenticationMode getAuthenticationMode()
```
    Get the authentication mode to use when storing or retrieving data with this GluonClient instance.
    
    Returns:
    
    the authentication mode to use when storing or retrieving data
  - getOperationMode
```
public OperationMode getOperationMode()
```
    Get the operation mode to use when storing or retrieving data with this GluonClient instance.
    
    Returns:
    
    the operation mode to use when storing or retrieving data
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Check whether the application is successfully authenticated with a user. When the authentication mode is set to AuthenticationMode.PUBLIC, this method will always return true.
    
    Returns:
    
    true when an authenticated user is available, false otherwise.
  - getAuthenticatedUser
```
public User getAuthenticatedUser()
```
    Gets the value of the property authenticatedUser. The returned value can be null when no user is currently authenticated.
    
    Returns:
    
    The current authenticated user or null if no user is authenticated.
  - authenticatedUserProperty
```
public javafx.beans.property.ReadOnlyObjectProperty<User> authenticatedUserProperty()
```
    A property that holds the currently authenticated user. The property can contain a null value if no user is currently authenticated.
    
    See Also:
    
    getAuthenticatedUser()
  - authenticate
```
public void authenticate(java.lang.Runnable runnable)
```
    Start the authentication flow. When authentication has completed successfully, the provided runnable will be called. If a user was already authenticated when making this call, the runnable will be called immediately.
    
    Parameters:
    
    runnable - a runnable that will be called when authentication has completed successfully
  - authenticate
```
public <V> void authenticate(java.util.concurrent.Callable<V> callable)
```
    Start the authentication flow. When authentication has completed successfully, the provided callable will be called. If a user was already authenticated when making this call, the callable will be called immediately.
    
    Type Parameters:
    
    V - the type of the object that is returned from the provided callable
    
    Parameters:
    
    callable - a callable that will be called when authentication has completed successfully
  - authenticate
```
public <O> void authenticate(java.util.function.Consumer<O> consumer,
                             O acceptable)
```
    Start the authentication flow. When authentication has completed successfully, the provided consumer's accept method will be called providing the provided acceptable object. If a user was already authenticated when making this call, the consumer will be called immediately.
    
    Type Parameters:
    
    O - The type of the acceptable object that will be accepted by the consumer.
    
    Parameters:
    
    consumer - a consumer that will be called when authentication has completed successfully
    
    acceptable - the object to pass to the consumer's accept method, can be null
  - createObjectDataReader
```
public <T> ObjectDataReader<T> createObjectDataReader(java.lang.String identifier,
                                                      java.lang.Class<T> objectClass,
                                                      SyncFlag... syncFlags)
```
    Creates an instance of ObjectDataReader that can be passed directly in the DataProvider.retrieveObject(ObjectDataReader) method. The object data reader will read the object with the specified identifier from Gluon CloudLink.
    Any of the following synchronization flags can be passed in with the syncFlags parameter: SyncFlag.OBJECT_READ_THROUGH and SyncFlag.OBJECT_WRITE_THROUGH. All other values will be silently ignored.
    
    Type Parameters:
    
    T - the type of the object that is retrieved
    
    Parameters:
    
    identifier - the identifier of the object to retrieve from Gluon CloudLink
    
    objectClass - the class of the object to retrieve
    
    syncFlags - an optional list of synchronization flags
    
    Returns:
    
    an ObjectDataReader instance that reads the object from Gluon CloudLink with the specified parameters
  - createObjectDataWriter
```
public <T> ObjectDataWriter<T> createObjectDataWriter(java.lang.String identifier,
                                                      java.lang.Class<T> objectClass,
                                                      SyncFlag... syncFlags)
```
    Creates an instance of ObjectDataWriter that can be passed directly in the DataProvider.storeObject(Object, ObjectDataWriter) method. The object data writer will send the object with the specified identifier to Gluon CloudLink.
    Any of the following synchronization flags can be passed in with the syncFlags parameter: SyncFlag.OBJECT_READ_THROUGH and SyncFlag.OBJECT_WRITE_THROUGH. All other values will be silently ignored.
    
    Type Parameters:
    
    T - the type of the object that is stored
    
    Parameters:
    
    identifier - the identifier of the object to store in Gluon CloudLink
    
    objectClass - the class of the object to store
    
    syncFlags - an optional list of synchronization flags
    
    Returns:
    
    an ObjectDataWriter instance that writes the object to Gluon CloudLink with the specified parameters
  - createObjectDataRemover
```
public <T> ObjectDataRemover<T> createObjectDataRemover()
```
    Creates an instance of ObjectDataRemover that can be passed directly in the DataProvider.removeObject(GluonObservableObject, ObjectDataRemover) method. The observable object that is passed in with the removeObject method will be used to get information about which object needs to be removed from Gluon CloudLink.
    Note: this method can only be used for removing observable objects that were either retrieved using an ObjectDataReader created by a GluonClient instance or stored using an ObjectDataWriter created by a GluonClient instance.
    
    Type Parameters:
    
    T - the type of the object to remove
    
    Returns:
    
    an ObjectDataRemover instance that removes an object from Gluon CloudLink
  - createListDataReader
```
public <E> ListDataReader<E> createListDataReader(java.lang.String identifier,
                                                  java.lang.Class<E> objectClass)
```
    Creates an instance of ListDataReader that can be passed directly in the DataProvider.retrieveList(ListDataReader) method. This method is the same as calling createListDataReader(String, Class, SyncFlag...) with the following two synchronization flags: SyncFlag.LIST_READ_THROUGH and SyncFlag.LIST_WRITE_THROUGH.
    
    Type Parameters:
    
    E - the type of the objects contained in the list to read
    
    Parameters:
    
    identifier - the identifier of the list to retrieve from Gluon CloudLink
    
    objectClass - the class of the objects contained in the list to read
    
    Returns:
    
    a ListDataReader instance that reads a list together with its objects from Gluon CloudLink with the specified parameters
  - createListDataReader
```
public <E> ListDataReader<E> createListDataReader(java.lang.String identifier,
                                                  java.lang.Class<E> objectClass,
                                                  SyncFlag... syncFlags)
```
    Creates an instance of ListDataReader that can be passed directly in the DataProvider.retrieveList(ListDataReader) method. The list data reader will read the list with the specified identifier together with the objects it contains from Gluon CloudLink.
    
    Type Parameters:
    
    E - the type of the objects contained in the list to read
    
    Parameters:
    
    identifier - the identifier of the list to retrieve from Gluon CloudLink
    
    objectClass - the class of the objects contained in the list to read
    
    syncFlags - an optional list of synchronization flags
    
    Returns:
    
    a ListDataReader instance that reads a list together with its objects from Gluon CloudLink with the specified parameters
  - push
```
public <E> void push(GluonObservableList<E> list)
```
    Push any changes made to the list to Gluon CloudLink. This method is the same as calling push(GluonObservableList, boolean) with a value of true for the fully parameter.
    
    Type Parameters:
    
    E - the type of the objects contained in the list to push
    
    Parameters:
    
    list - the observable list to push to Gluon CloudLink
    
    See Also:
    
    push(GluonObservableList, boolean)
  - push
```
public <E> void push(GluonObservableList<E> list,
                     boolean fully)
```
    Push any changes made to the list to Gluon CloudLink. This method is useful for lists that are retrieved without write through flags. Every time an item is removed, added or updated in the list, that item will be marked for removal, addition or update respectively. When calling this method, these marks will be checked for on every item and reflected back to the list on Gluon CloudLink. Should an item have multiple markers, the order of precedence of the markers is as follows: removal over addition over update.
    When the fully parameter is set to true, all items in the list will be considered as marked for update. Otherwise, only items that were removed or added or updated manually will be updated on Gluon CloudLink. Again, note that when using fully with a value of true, items that were marked for removal will still be removed because the removal marker takes precedence over the update marker.
    
    Type Parameters:
    
    E - the type of the objects contained in the list to push
    
    Parameters:
    
    list - the observable list to push to Gluon CloudLink
    
    fully - when true all items in the list are considered as marked for update
  - push
```
public <T> void push(GluonObservableObject<T> object)
```
    Push any changes made to the object to Gluon CloudLink. This method is useful for objects that are retrieved without the write through flag.
    A push can be used as a convenient way to store updates to an observable object that was already retrieved. Consider the following code, to see an example of the push method:
```
     GluonObservableObject<Sample> sample = DataProvider.retrieveObject(gluonClient.createObjectDataReader("sample", Sample.class));

     // somewhere the object gets updated and you want to store the updates
     gluonClient.push(sample);
 
```
    Actually, the push method is a simple alternative to the storeObject method that is available in DataProvider. Using that method, updating the object in Gluon CloudLink can be done as follows, which is more cumbersome to write and you need to pass in the object identifier again:
```
     DataProvider.storeObject(sample.get(), gluonClient.createObjectDataWriter("sample", Sample.class));
 
```
    Note: this method can only be used with observable objects that were either retrieved using an ObjectDataReader created by a GluonClient instance or stored using an ObjectDataWriter created by a GluonClient instance.
    Type Parameters:
    
    T - the type of the object to push
    
    Parameters:
    
    object - the observable object to push to Gluon CloudLink
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class GluonClient

Property Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

authenticatedUser

Method Detail

getHost

getCredentials

getAuthenticationMode

getOperationMode

isAuthenticated

getAuthenticatedUser

authenticatedUserProperty

authenticate

authenticate

authenticate

createObjectDataReader

createObjectDataWriter

createObjectDataRemover

createListDataReader

createListDataReader

push

push

push

toString