me.figo

Class FigoConnection

java.lang.Object

me.figo.FigoApi

me.figo.FigoConnection

public class FigoConnection
extends FigoApi

Representing a not user-bound connection to the figo connect API. Its main purpose is to let user login via the OAuth2 API and/or create business processes.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clientId
protected String	clientSecret
protected String	redirectUri

Fields inherited from class me.figo.FigoApi

API_FIGO_LIVE, API_FIGO_STAGE

Constructor Summary

Constructors

Constructor and Description
FigoConnection(String clientId, String clientSecret, String redirectUri) Creates a FigoConnection instance
FigoConnection(String clientId, String clientSecret, String redirectUri, int timeout) Creates a FigoConnection instance
FigoConnection(String clientId, String clientSecret, String redirectUri, int timeout, String apiEndpoint) Creates a FigoConnection instance

Method Summary

Modifier and Type	Method and Description
String	addUser(String name, String email, String password, String language) Create a new figo Account
TokenResponse	addUserAndLogin(String name, String email, String password, String language) Creates a new figo User and returns a login token
TokenResponse	convertAuthenticationCode(String authenticationCode) Convert the authentication code received as result of the login process into an access token usable for data access.
TokenResponse	convertRefreshToken(String refreshToken) Convert a refresh token (granted for offline access and returned by `convert_authentication_code`) into an access token usable for data access.
ProcessToken	createProcess(BusinessProcess process) Create a new business process
TokenResponse	credentialLogin(String username, String password) Login an user with his figo username and password credentials
String	getLoginUrl(String scope, String state) The URL a user should open in his/her web browser to start the login process.
void	revokeToken(String token) Revoke a granted access or refresh token and thereby invalidate it.
void	startProcess(ProcessToken processToken) Start a new business process

Methods inherited from class me.figo.FigoApi

createGson, getApiEndpoint, getTimeout, handleResponse, processResponse, queryApi, setProxy, setTimeout, setTrustManager, setupTrustManager

Methods inherited from class java.lang.Object

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

Field Detail

clientId

protected String clientId

clientSecret

protected String clientSecret

redirectUri

protected String redirectUri

Constructor Detail

FigoConnection

public FigoConnection(String clientId,
                      String clientSecret,
                      String redirectUri)

Creates a FigoConnection instance

Parameters:

clientId - the OAuth Client ID as provided by your figo developer contact

clientSecret - the OAuth Client Secret as provided by your figo developer contact

redirectUri - the URI the users gets redirected to after the login is finished or if he presses cancels

FigoConnection

public FigoConnection(String clientId,
                      String clientSecret,
                      String redirectUri,
                      int timeout)

Creates a FigoConnection instance

Parameters:

clientId - the OAuth Client ID as provided by your figo developer contact

clientSecret - the OAuth Client Secret as provided by your figo developer contact

redirectUri - the URI the users gets redirected to after the login is finished or if he presses cancels

timeout - the timeout used for queries

FigoConnection

public FigoConnection(String clientId,
                      String clientSecret,
                      String redirectUri,
                      int timeout,
                      String apiEndpoint)

Creates a FigoConnection instance

Parameters:

clientId - the OAuth Client ID as provided by your figo developer contact

clientSecret - the OAuth Client Secret as provided by your figo developer contact

redirectUri - the URI the users gets redirected to after the login is finished or if he presses cancels

timeout - the timeout used for queries

apiEndpoint - which endpoint to use (customize for different figo deployment)

Method Detail

getLoginUrl

public String getLoginUrl(String scope,
                          String state)

The URL a user should open in his/her web browser to start the login process. When the process is completed, the user is redirected to the URL provided to the constructor and passes on an authentication code. This code can be converted into an access token for data access.

Parameters:

scope - Scope of data access to ask the user for, e.g. `accounts=ro`

state - String passed on through the complete login process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

Returns:

the URL of the first page of the login process

convertAuthenticationCode

public TokenResponse convertAuthenticationCode(String authenticationCode)
                                        throws FigoException,
                                               IOException

Convert the authentication code received as result of the login process into an access token usable for data access.

Parameters:

authenticationCode - the code received as part of the call to the redirect URL at the end of the long process

Returns:

HashMap with the following keys: - `access_token` - the access token for data access. You can pass it into `FigoConnection.open_session` to get a FigoSession and access the users data - `refresh_token` - if the scope contained the `offline` flag, also a refresh token is generated. It can be used to generate new access tokens, when the first one has expired. - `expires_in` - absolute time the access token expires

Throws:

FigoException

IOException

convertRefreshToken

public TokenResponse convertRefreshToken(String refreshToken)
                                  throws IOException,
                                         FigoException

Convert a refresh token (granted for offline access and returned by `convert_authentication_code`) into an access token usable for data access.

Parameters:

refreshToken - refresh token returned by `convert_authentication_code`

Returns:

Dictionary with the following keys: - `access_token` - the access token for data access. You can pass it into `FigoConnection.open_session` to get a FigoSession and access the users data - `expires_in` - absolute time the access token expires

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

credentialLogin

public TokenResponse credentialLogin(String username,
                                     String password)
                              throws IOException,
                                     FigoException

Login an user with his figo username and password credentials

Parameters:

username - the user's figo username, this is the `email` from the `CreateUserRequest`

password - the user's figo password

Returns:

Dictionary with the following keys: - `access_token` - the access token for data access. You can pass it into `FigoConnection.open_session` to get a FigoSession and access the users data - `expires_in` - absolute time the access token expires

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

revokeToken

public void revokeToken(String token)
                 throws IOException,
                        FigoException

Revoke a granted access or refresh token and thereby invalidate it. Note: this action has immediate effect, i.e. you will not be able use that token anymore after this call.

Parameters:

token - access or refresh token to be revoked

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

addUser

public String addUser(String name,
                      String email,
                      String password,
                      String language)
               throws IOException,
                      FigoException

Create a new figo Account

Parameters:

name - First and last name

email - Email address; It must obey the figo username and password policy

password - New figo Account password; It must obey the figo username and password policy

language - Two-letter code of preferred language

Returns:

Auto-generated recovery password

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

addUserAndLogin

public TokenResponse addUserAndLogin(String name,
                                     String email,
                                     String password,
                                     String language)
                              throws IOException,
                                     FigoException

Creates a new figo User and returns a login token

Parameters:

name - First and last name

email - Email address; It must obey the figo username and password policy

password - New figo Account password; It must obey the figo username and password policy

language - Two-letter code of preferred language

Returns:

TokenResponse for further API requests

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

startProcess

public void startProcess(ProcessToken processToken)
                  throws FigoException,
                         IOException

Start a new business process

Parameters:

processToken - The unique token that was created by createProcess

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

createProcess

public ProcessToken createProcess(BusinessProcess process)
                           throws FigoException,
                                  IOException

Create a new business process

Parameters:

process - BusinessProcess object which contains the figo user credentials and the processes to execute

Returns:

Unique process token to use when starting the process

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException