com.gluonhq.charm.connect.view

Class LoginMethod

java.lang.Object

com.gluonhq.charm.connect.view.LoginMethod

public class LoginMethod
extends java.lang.Object

A LoginMethod is used to specify which method should be used to connect users to the Gluon Cloud. Connecting a user to Gluon Cloud is initiated by calling the connect URL, for instance in a WebView. The URL will start the connect process on Gluon Cloud and might redirect the browser to another website, e.g. Facebook. When the connect flow has finished, the browser will finally be redirected to the callback URL. The response from this URL contains information about the connected user as a JSON object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoginMethod.Type Defines the different methods by which you can log in to Gluon Cloud.

Constructor Summary

Constructors

Constructor and Description
LoginMethod(LoginMethod.Type type, java.lang.String gluonBaseUrl, java.lang.String gluonApplicationKey) Create a new LoginMethod with the specified properties.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCallbackUrl() Constructs the URL that identifies the callback URL that will be called on Gluon Cloud as the final step in the connect flow.
java.lang.String	getConnectUrl() Constructs the URL that needs to be called to initiate the connect flow for this login method on Gluon Cloud.
LoginMethod.Type	getType() Returns the type of the LoginMethod and defines which service will be used for connecting Gluon Cloud users.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginMethod

public LoginMethod(LoginMethod.Type type,
                   java.lang.String gluonBaseUrl,
                   java.lang.String gluonApplicationKey)

Create a new LoginMethod with the specified properties.

Parameters:

type - the type of the login method.

gluonBaseUrl - the base URL to Gluon Cloud.

gluonApplicationKey - the application key to which this LoginMethod belongs to.

Method Detail

getType

public LoginMethod.Type getType()

Returns the type of the LoginMethod and defines which service will be used for connecting Gluon Cloud users.

Returns:

the type of the LoginMethod.

getConnectUrl

public java.lang.String getConnectUrl()

Constructs the URL that needs to be called to initiate the connect flow for this login method on Gluon Cloud. The URL can be loaded into a WebView to start the flow.

Returns:

a string representing a URL to initiate the connect flow.

getCallbackUrl

public java.lang.String getCallbackUrl()

Constructs the URL that identifies the callback URL that will be called on Gluon Cloud as the final step in the connect flow. When the location property of a WebView's WebEngine starts with the callback URL, you know that the connect flow has finished.

Returns:

a string representing the callback URL that indicates the end of the connect flow.