com.gluonhq.charm.connect.service

Class AuthenticationService

java.lang.Object

com.gluonhq.charm.connect.service.CharmService

com.gluonhq.charm.connect.service.AuthenticationService

public class AuthenticationService
extends CharmService

The AuthenticationService provides a way to authenticate a user within the application. It also keeps track of which user is currently authenticated.

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyObjectProperty<User>	authenticatedUser The user that is currently authenticated, which can be null if no user is authenticated.

Field Summary

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

gluonClient

Constructor Summary

Constructors

Constructor and Description
AuthenticationService(GluonClient gluonClient) The AuthenticationService allows the application to authenticate users and keep track of which user is currently logged in.

Method Summary

Modifier and Type	Method and Description
<O> void	authenticate(java.util.function.Consumer<O> consumer, O acceptable) Start the authentication flow.
javafx.beans.property.ReadOnlyObjectProperty<User>	authenticatedUserProperty() The user that is currently authenticated, which can be null if no user is authenticated.
User	getAuthenticatedUser() Gets the value of the property authenticatedUser.
boolean	isAuthenticated() Check whether the application is successfully authenticated with a user.

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

Property Detail

authenticatedUser

public javafx.beans.property.ReadOnlyObjectProperty<User> authenticatedUserProperty

The user that is currently authenticated, which can be null if no user is authenticated.

See Also:

getAuthenticatedUser()

Constructor Detail

AuthenticationService

public AuthenticationService(GluonClient gluonClient)

The AuthenticationService allows the application to authenticate users and keep track of which user is currently logged in.

The service will use the AuthenticationViewFactory to try and load an implementation of the AuthenticationView. Authentication will only be possible when an implementation could be found.

Whenever a user gets authenticated successfully, the information will be stored in the private storage of the device where the application is run. The next time the AuthenticationService is created, it will check if such information is available and automatically authenticate the user with the information that was stored.

Parameters:

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

Method Detail

isAuthenticated

public boolean isAuthenticated()

Check whether the application is successfully authenticated with a user.

Returns:

true when an authenticated user is available, false otherwise.

getAuthenticatedUser

public User getAuthenticatedUser()

Gets the value of the property authenticatedUser.

Returns:

The current authenticated user or null if no user is authenticated.

authenticatedUserProperty

public javafx.beans.property.ReadOnlyObjectProperty<User> authenticatedUserProperty()

The user that is currently authenticated, which can be null if no user is authenticated.

See Also:

getAuthenticatedUser()

authenticate

public <O> void authenticate(java.util.function.Consumer<O> consumer,
                             O acceptable)

Start the authentication flow. When authentication is complete, the consumer's accept method will be called providing the provided acceptable object.

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 is completed

acceptable - the object to pass to the consumer's accept method