com.gluonhq.connect.gluoncloud

Class LoginMethod

java.lang.Object

com.gluonhq.connect.gluoncloud.LoginMethod

public class LoginMethod
extends java.lang.Object

A LoginMethod is used to specify which method should be used for connecting users to your application. Connecting a user to Gluon CloudLink is initiated by calling the connect URL, for instance in a WebView. The URL will start the connect process on Gluon CloudLink 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.

Since:

1.0.0

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 CloudLink.

Constructor Summary

Constructors

Constructor and Description
LoginMethod(LoginMethod.Type type, java.lang.String gluonBaseUrl, GluonCredentials gluonCredentials) 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 CloudLink 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 CloudLink.
java.lang.String	getLoginUrl() Returns the URL that must be used when verifying the login credentials of a user when authenticating with the LoginMethod.Type.PASSWORD login method.
java.lang.String	getSignUpUrl() Returns the URL that must be used when signing up a new user that is authenticating with the LoginMethod.Type.PASSWORD login method.
LoginMethod.Type	getType() Returns the type of the LoginMethod and defines which service will be used for connecting Gluon CloudLink 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,
                   GluonCredentials gluonCredentials)

Create a new LoginMethod with the specified properties.

Parameters:

type - the type of the login method.

gluonBaseUrl - the base URL to Gluon CloudLink.

gluonCredentials - the application credentials 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 CloudLink 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 CloudLink. 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 CloudLink 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.

getLoginUrl

public java.lang.String getLoginUrl()

Returns the URL that must be used when verifying the login credentials of a user when authenticating with the LoginMethod.Type.PASSWORD login method. The returned URL must be used in an HTTP POST request, providing the following form parameters:

• username: the username of the user that was used when signing up
• password: the password of the user

The response is an object that contains an action, an optional user and an optional message. The action is a string containing one of the following values: CONNECT or FAILURE. The user is provided when the action equals CONNECT. Otherwise only the message is provided, explaining the reason of the failure in more detail.

Returns:

the URL to use for verifying login credentials of a user

getSignUpUrl

public java.lang.String getSignUpUrl()

Returns the URL that must be used when signing up a new user that is authenticating with the LoginMethod.Type.PASSWORD login method. The returned URL must be used in an HTTP POST request, providing the following form parameters:

• name: the full name of the user that is signing up (optional)
• username: the username of the user
• password: the password of the user

The username and password or both mandatory fields, as they are used to verify a user when logging in. The username must therefor also be unique across the application. The response of the HTTP request is an object that contains an action, an optional user and an optional message. The action is a string containing one of the following values: CONNECT or FAILURE. The user is provided when the action equals CONNECT. Otherwise only the message is provided, explaining the reason of the failure in more detail.

Returns:

the URL to use for signing up a new user