me.figo

Class FigoSession

java.lang.Object

me.figo.FigoSession

public class FigoSession
extends Object

Main entry point to the data access-part of the figo connect java library. Here you can retrieve all the data the user granted your app access to.

Author:

Stefan Richter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	access_token
protected String	apiEndpoint
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
FigoSession(String accessToken) Creates a FigoSession instance
FigoSession(String accessToken, int timeout) Creates a FigoSession instance
FigoSession(String accessToken, int timeout, String apiEndpoint) Creates a FigoSession instance

Method Summary

Modifier and Type	Method and Description
Notification	addNotification(Notification notification) Register a new notification on the server for the user
Payment	addPayment(Payment payment) Create a new payment
protected com.google.gson.Gson	createGson() Instantiate the GSON class.
Account	getAccount(String accountId) Returns the account with the specified ID
AccountBalance	getAccountBalance(Account account) Returns the balance details of the supplied account
AccountBalance	getAccountBalance(String accountId) Returns the balance details of the account with he specified ID
List<Account>	getAccounts() All accounts the user has granted your App access to
Bank	getBank(Account account) Get Bank for account
Bank	getBank(String bankId) Get bank
Notification	getNotification(String notificationId) Retrieve a specific notification by ID
List<Notification>	getNotifications() All notifications registered by this client for the user
Payment	getPayment(Account account, String paymentId) Retrieve a specific payment by ID
Payment	getPayment(String accountId, String paymentId) Retrieve a specific payment by ID
List<Payment>	getPayments() Retrieve all payments
List<Payment>	getPayments(Account account) all payments on a certain account
List<Payment>	getPayments(String accountId) Retrieve all payments on a certain account
String	getSyncURL(String state, String redirect_url) URL to trigger a synchronisation.
Transaction	getTransaction(String accountId, String transactionId) Retrieve a specific transaction by ID
List<Transaction>	getTransactions() All transactions on all account of the user
List<Transaction>	getTransactions(Account account) Retrieve all transactions on a specific account of the user
List<Transaction>	getTransactions(Account account, String since, Integer count, Integer offset, Boolean include_pending) Get an array of Transaction objects, one for each transaction of the user matching the criteria.
List<Transaction>	getTransactions(String accountId) Retrieve all transactions on a specific account of the user
List<Transaction>	getTransactions(String accountId, String since, Integer count, Integer offset, Boolean include_pending) Get an array of Transaction objects, one for each transaction of the user matching the criteria.
User	getUser() Get the current figo Account
protected <T> T	queryApi(String path, Object data, String method, Type typeOfT) Query the figo API via HTTP
void	removeAccount(Account account) Remove an account
void	removeAccount(String accountId) Remove an account
void	removeBankPin(Bank bank) Remove the stored PIN for a bank (if there was one)
void	removeBankPin(String bankId) Remove the stored PIN for a bank (if there was one)
void	removeNotification(Notification notification) Remove a stored notification from the server
void	removePayment(Payment payment) Remove a stored payment from the server
void	removeUser() Delete figo Account
String	submitPayment(Payment payment, String tanSchemeId, String state) Submit payment to bank server
String	submitPayment(Payment payment, String tanSchemeId, String state, String redirectUri) Submit payment to bank server
Account	updateAccount(Account account) Modify an account
AccountBalance	updateAccountBalance(Account account, AccountBalance accountBalance) Modify balance or account limits
AccountBalance	updateAccountBalance(String accountId, AccountBalance accountBalance) Modify balance or account limits
Bank	updateBank(Bank bank) Modify a bank
Notification	updateNotification(Notification notification) Update a stored notification
Payment	updatePayment(Payment payment) Update a stored payment
User	updateUser(User user) Modify figo Account

Methods inherited from class java.lang.Object

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

Field Detail

apiEndpoint

protected String apiEndpoint

access_token

protected String access_token

timeout

protected int timeout

Constructor Detail

FigoSession

public FigoSession(String accessToken)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

FigoSession

public FigoSession(String accessToken,
                   int timeout)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

timeout - the timeout used for queries

FigoSession

public FigoSession(String accessToken,
                   int timeout,
                   String apiEndpoint)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

timeout - the timeout used for queries

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

Method Detail

queryApi

protected <T> T queryApi(String path,
                         Object data,
                         String method,
                         Type typeOfT)
                  throws FigoException,
                         IOException

Query the figo API via HTTP

Type Parameters:

T - Type of expected response

Parameters:

path - Endpoint to query

data - Payload to send

method - HTTP verb to use

typeOfT - Type of expected response

Returns:

decoded response

Throws:

FigoException

IOException

createGson

protected com.google.gson.Gson createGson()

Instantiate the GSON class. Meant to be overridden in order to provide custom Gson settings.

Returns:

GSON instance

getUser

public User getUser()
             throws FigoException,
                    IOException

Get the current figo Account

Returns:

User for the current figo Account

Throws:

FigoException

IOException

updateUser

public User updateUser(User user)
                throws FigoException,
                       IOException

Modify figo Account

Parameters:

user - modified user object to be saved

Returns:

User object for the updated figo Account

Throws:

FigoException

IOException

removeUser

public void removeUser()
                throws FigoException,
                       IOException

Delete figo Account

Throws:

FigoException

IOException

getAccounts

public List<Account> getAccounts()
                          throws FigoException,
                                 IOException

All accounts the user has granted your App access to

Returns:

List of Accounts

Throws:

FigoException

IOException

getAccount

public Account getAccount(String accountId)
                   throws FigoException,
                          IOException

Returns the account with the specified ID

Parameters:

accountId - figo ID of the account to be retrieved

Returns:

Account or Null

Throws:

FigoException

IOException

updateAccount

public Account updateAccount(Account account)
                      throws FigoException,
                             IOException

Modify an account

Parameters:

account - the modified account to be saved

Returns:

Account object for the updated account returned by server

Throws:

FigoException

IOException

removeAccount

public void removeAccount(String accountId)
                   throws FigoException,
                          IOException

Remove an account

Parameters:

accountId - ID of the account to be removed

Throws:

FigoException

IOException

removeAccount

public void removeAccount(Account account)
                   throws FigoException,
                          IOException

Remove an account

Parameters:

account - Account to be removed

Throws:

FigoException

IOException

getAccountBalance

public AccountBalance getAccountBalance(String accountId)
                                 throws FigoException,
                                        IOException

Returns the balance details of the account with he specified ID

Parameters:

accountId - figo ID of the account to be retrieved

Returns:

AccountBalance or Null

Throws:

FigoException

IOException

getAccountBalance

public AccountBalance getAccountBalance(Account account)
                                 throws FigoException,
                                        IOException

Returns the balance details of the supplied account

Parameters:

account - account whos balance should be retrieved

Returns:

AccountBalance or Null

Throws:

FigoException

IOException

updateAccountBalance

public AccountBalance updateAccountBalance(String accountId,
                                           AccountBalance accountBalance)
                                    throws FigoException,
                                           IOException

Modify balance or account limits

Parameters:

accountId - ID of the account to be modified

accountBalance - modified AccountBalance object to be saved

Returns:

AccountBalance object for the updated account as returned by the server

Throws:

FigoException

IOException

updateAccountBalance

public AccountBalance updateAccountBalance(Account account,
                                           AccountBalance accountBalance)
                                    throws FigoException,
                                           IOException

Modify balance or account limits

Parameters:

account - account to be modified

accountBalance - modified AccountBalance object to be saved

Returns:

AccountBalance object for the updated account as returned by the server

Throws:

FigoException

IOException

getTransactions

public List<Transaction> getTransactions()
                                  throws FigoException,
                                         IOException

All transactions on all account of the user

Returns:

List of Transaction objects

Throws:

FigoException

IOException

getTransactions

public List<Transaction> getTransactions(String accountId)
                                  throws FigoException,
                                         IOException

Retrieve all transactions on a specific account of the user

Parameters:

accountId - the ID of the account for which to retrieve the transactions

Returns:

List of Transactions

Throws:

FigoException

IOException

getTransactions

public List<Transaction> getTransactions(Account account)
                                  throws FigoException,
                                         IOException

Retrieve all transactions on a specific account of the user

Parameters:

account - the account for which to retrieve the transactions

Returns:

List of Transactions

Throws:

FigoException

IOException

getTransactions

public List<Transaction> getTransactions(Account account,
                                         String since,
                                         Integer count,
                                         Integer offset,
                                         Boolean include_pending)
                                  throws FigoException,
                                         IOException

Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.

Parameters:

account - account for which to list the transactions

since - this parameter can either be a transaction ID or a date

count - limit the number of returned transactions

offset - which offset into the result set should be used to determin the first transaction to return (useful in combination with count)

include_pending - this flag indicates whether pending transactions should be included in the response; pending transactions are always included as a complete set, regardless of the `since` parameter

Returns:

an array of Transaction objects

Throws:

FigoException

IOException

getTransactions

public List<Transaction> getTransactions(String accountId,
                                         String since,
                                         Integer count,
                                         Integer offset,
                                         Boolean include_pending)
                                  throws FigoException,
                                         IOException

Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.

Parameters:

accountId - ID of the account for which to list the transactions

since - this parameter can either be a transaction ID or a date

count - limit the number of returned transactions

offset - which offset into the result set should be used to determin the first transaction to return (useful in combination with count)

include_pending - this flag indicates whether pending transactions should be included in the response; pending transactions are always included as a complete set, regardless of the `since` parameter

Returns:

an array of Transaction objects

Throws:

FigoException

IOException

getTransaction

public Transaction getTransaction(String accountId,
                                  String transactionId)
                           throws FigoException,
                                  IOException

Retrieve a specific transaction by ID

Parameters:

accountId - ID of the account on which the transaction occured

transactionId - the figo ID of the specific transaction

Returns:

Transaction or null

Throws:

FigoException

IOException

getBank

public Bank getBank(String bankId)
             throws FigoException,
                    IOException

Get bank

Parameters:

bankId - ID of the bank to be retrieved

Returns:

Bank or null

Throws:

FigoException

IOException

getBank

public Bank getBank(Account account)
             throws FigoException,
                    IOException

Get Bank for account

Parameters:

account - Account for which to return the Bank

Returns:

Bank or Null

Throws:

FigoException

IOException

updateBank

public Bank updateBank(Bank bank)
                throws FigoException,
                       IOException

Modify a bank

Parameters:

bank - modified bank object to be saved

Returns:

Bank object for the updated bank

Throws:

FigoException

IOException

removeBankPin

public void removeBankPin(String bankId)
                   throws FigoException,
                          IOException

Remove the stored PIN for a bank (if there was one)

Parameters:

bankId - ID of the bank whose pin should be removed

Throws:

FigoException

IOException

removeBankPin

public void removeBankPin(Bank bank)
                   throws FigoException,
                          IOException

Remove the stored PIN for a bank (if there was one)

Parameters:

bank - bank whose pin should be removed

Throws:

FigoException

IOException

getNotifications

public List<Notification> getNotifications()
                                    throws FigoException,
                                           IOException

All notifications registered by this client for the user

Returns:

List of Notification objects

Throws:

FigoException

IOException

getNotification

public Notification getNotification(String notificationId)
                             throws FigoException,
                                    IOException

Retrieve a specific notification by ID

Parameters:

notificationId - figo ID for the notification to be retrieved

Returns:

Notification or Null

Throws:

FigoException

IOException

addNotification

public Notification addNotification(Notification notification)
                             throws FigoException,
                                    IOException

Register a new notification on the server for the user

Parameters:

notification - Notification which should be registered

Returns:

the newly registered Notification

Throws:

FigoException

IOException

updateNotification

public Notification updateNotification(Notification notification)
                                throws FigoException,
                                       IOException

Update a stored notification

Parameters:

notification - Notification with updated values

Throws:

FigoException

IOException

removeNotification

public void removeNotification(Notification notification)
                        throws FigoException,
                               IOException

Remove a stored notification from the server

Parameters:

notification - Notification to be removed

Throws:

FigoException

IOException

getPayments

public List<Payment> getPayments()
                          throws FigoException,
                                 IOException

Retrieve all payments

Returns:

List of Payments

Throws:

FigoException

IOException

getPayments

public List<Payment> getPayments(String accountId)
                          throws FigoException,
                                 IOException

Retrieve all payments on a certain account

Parameters:

accountId - the ID of the account for which to retrieve the payments

Returns:

List of Payments

Throws:

FigoException

IOException

getPayments

public List<Payment> getPayments(Account account)
                          throws FigoException,
                                 IOException

all payments on a certain account

Parameters:

account - the account for which to retrieve the payments

Returns:

List of Payments

Throws:

FigoException

IOException

getPayment

public Payment getPayment(String accountId,
                          String paymentId)
                   throws FigoException,
                          IOException

Retrieve a specific payment by ID

Parameters:

accountId - ID of the account on which the payment can be found

paymentId - ID of the payment to be retrieved

Returns:

Payment or Null

Throws:

FigoException

IOException

getPayment

public Payment getPayment(Account account,
                          String paymentId)
                   throws FigoException,
                          IOException

Retrieve a specific payment by ID

Parameters:

account - the account on which the payment can be found

paymentId - ID of the payment to be retrieved

Returns:

Payment or Null

Throws:

FigoException

IOException

addPayment

public Payment addPayment(Payment payment)
                   throws FigoException,
                          IOException

Create a new payment

Parameters:

payment - Payment which should be created

Returns:

the newly created payment

Throws:

FigoException

IOException

updatePayment

public Payment updatePayment(Payment payment)
                      throws FigoException,
                             IOException

Update a stored payment

Parameters:

payment - Payment with updated values

Returns:

updated Payment as returned by the server

Throws:

FigoException

IOException

removePayment

public void removePayment(Payment payment)
                   throws FigoException,
                          IOException

Remove a stored payment from the server

Parameters:

payment - payment to be removed

Throws:

FigoException

IOException

submitPayment

public String submitPayment(Payment payment,
                            String tanSchemeId,
                            String state)
                     throws FigoException,
                            IOException

Submit payment to bank server

Parameters:

payment - payment to be submitted

tanSchemeId - TAN scheme ID of user-selected TAN scheme

state - Any kind of string that will be forwarded in the callback response message

Returns:

the URL to be opened by the user for the TAN process

Throws:

FigoException

IOException

submitPayment

public String submitPayment(Payment payment,
                            String tanSchemeId,
                            String state,
                            String redirectUri)
                     throws FigoException,
                            IOException

Submit payment to bank server

Parameters:

payment - payment to be submitted

tanSchemeId - TAN scheme ID of user-selected TAN scheme

state - Any kind of string that will be forwarded in the callback response message

redirectUri - At the end of the submission process a response will be sent to this callback URL

Returns:

the URL to be opened by the user for the TAN process

Throws:

FigoException

IOException

getSyncURL

public String getSyncURL(String state,
                         String redirect_url)
                  throws FigoException,
                         IOException

URL to trigger a synchronisation. The user should open this URL in a web browser to synchronize his/her accounts with the respective bank servers. When the process is finished, the user is redirected to the provided URL.

Parameters:

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

redirect_url - URI the user is redirected to after the process completes

Returns:

the URL to be opened by the user

Throws:

FigoException

IOException