Class EbicsClient

java.lang.Object

org.kopi.ebics.client.EbicsClient

public class EbicsClient
extends Object

The ebics client application. Performs necessary tasks to contact the ebics bank server like sending the INI, HIA and HPB requests for keys retrieval and also performs the files transfer including uploads and downloads.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EbicsClient.ConfigProperties

Constructor Summary

Constructors

Constructor	Description
EbicsClient(Configuration configuration, EbicsClient.ConfigProperties properties)	Constructs a new ebics client application

Method Summary

Modifier and Type	Method	Description
void	clearTraces()
void	createDefaultUser()
static EbicsClient	createEbicsClient(File rootDir, File configFile)
User	createUser(URL url, String bankName, String hostId, String partnerId, String userId, String name, String email, String country, String organization, boolean saveCertificates, PasswordCallback passwordCallback)	Creates a new ebics user and generates its certificates.
void	createUserDirectories(EbicsUser user)	Creates the user necessary directories
void	fetchFile(File file, User user, Product product, EbicsOrderType orderType, boolean isTest)
void	fetchFile(File file, User user, Product product, EbicsOrderType orderType, EbicsDownloadParams downloadParams, boolean isTest)	Downloads a file from the bank.
void	fetchFile(File file, EbicsOrderType orderType, Date start, Date end)	Downloads a file for a report period.
void	fetchFile(File file, EbicsOrderType orderType, EbicsDownloadParams downloadParams)	Downloads a file for the default user, with EBICS 3.0 service parameters.
User	getDefaultUser()
void	loadDefaultUser()
User	loadUser(String hostId, String partnerId, String userId, PasswordCallback passwordCallback)	Loads a user knowing its ID
static void	main(String[] args)
void	quit()	Performs buffers save before quitting the client application.
void	revokeSubscriber(User user, Product product)	Sends the SPR order to the bank.
void	sendFile(File file, User user, Product product, EbicsOrderType orderType, EbicsUploadParams params)	Sends a file to the ebics bank server
void	sendFile(File file, EbicsOrderType orderType)
void	sendFile(File file, EbicsOrderType orderType, EbicsUploadParams params)
void	sendHIARequest(User user, Product product)	Sends a HIA request to the ebics server.
void	sendHPBRequest(User user, Product product)	Sends a HPB request to the ebics server.
void	sendINIRequest(User user, Product product)	Sends an INI request to the ebics bank server

Methods inherited from class Object

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

Constructor Details

EbicsClient

public EbicsClient(Configuration configuration,
 EbicsClient.ConfigProperties properties)

Constructs a new ebics client application

Parameters:

configuration - the application configuration

properties -

Method Details

createUserDirectories

public void createUserDirectories(EbicsUser user)

Creates the user necessary directories

Parameters:

user - the concerned user

createUser

public User createUser(URL url,
 String bankName,
 String hostId,
 String partnerId,
 String userId,
 String name,
 String email,
 String country,
 String organization,
 boolean saveCertificates,
 PasswordCallback passwordCallback)
                throws Exception

Creates a new ebics user and generates its certificates.

Parameters:

url - the bank url

bankName - the bank name

hostId - the bank host ID

partnerId - the partner ID

userId - UserId as obtained from the bank.

name - the user name,

email - the user email

country - the user country

organization - the user organization or company

saveCertificates - save generated certificates?

passwordCallback - a callback-handler that supplies us with the password. This parameter can be null, in this case no password is used.

Returns:

Ebics User

Throws:

Exception

loadUser

public User loadUser(String hostId,
 String partnerId,
 String userId,
 PasswordCallback passwordCallback)
              throws Exception

Loads a user knowing its ID

Throws:

Exception

sendINIRequest

public void sendINIRequest(User user,
 Product product)
                    throws Exception

Sends an INI request to the ebics bank server

Parameters:

user - the user

product - the application product

Throws:

Exception

sendHIARequest

public void sendHIARequest(User user,
 Product product)
                    throws Exception

Sends a HIA request to the ebics server.

Parameters:

user - the user ID.

product - the application product.

Throws:

Exception

sendHPBRequest

public void sendHPBRequest(User user,
 Product product)
                    throws Exception

Sends a HPB request to the ebics server.

Throws:

Exception

revokeSubscriber

public void revokeSubscriber(User user,
 Product product)
                      throws Exception

Sends the SPR order to the bank.

Parameters:

user - the user ID

product - the session product

Throws:

Exception

sendFile

public void sendFile(File file,
 User user,
 Product product,
 EbicsOrderType orderType,
 EbicsUploadParams params)
              throws Exception

Sends a file to the ebics bank server

Throws:

Exception

sendFile

public void sendFile(File file,
 EbicsOrderType orderType,
 EbicsUploadParams params)
              throws Exception

Throws:

Exception

sendFile

public void sendFile(File file,
 EbicsOrderType orderType)
              throws Exception

Throws:

Exception

fetchFile

public void fetchFile(File file,
 User user,
 Product product,
 EbicsOrderType orderType,
 boolean isTest)
               throws IOException,
EbicsException

Throws:

IOException

EbicsException

fetchFile

public void fetchFile(File file,
 EbicsOrderType orderType,
 EbicsDownloadParams downloadParams)
               throws IOException,
EbicsException

Downloads a file for the default user, with EBICS 3.0 service parameters.

The counterpart of sendFile(File, EbicsOrderType, EbicsUploadParams): callers that use the default user have no other way to reach the BTD path, since the default product is not exposed.

Throws:

IOException

EbicsException

fetchFile

public void fetchFile(File file,
 User user,
 Product product,
 EbicsOrderType orderType,
 EbicsDownloadParams downloadParams,
 boolean isTest)
               throws IOException,
EbicsException

Downloads a file from the bank.

Parameters:

downloadParams - optional EBICS 3.0 service parameters and report period; with a service name set the order is sent as a BTD business transaction format order

Throws:

IOException

EbicsException

fetchFile

public void fetchFile(File file,
 EbicsOrderType orderType,
 Date start,
 Date end)
               throws IOException,
EbicsException

Downloads a file for a report period.

A Date is an instant, the EBICS report period is a pair of calendar days. The calendar day is therefore read in the timezone of the machine running this code, so a Date at UTC midnight becomes the previous day in any zone west of UTC. Prefer fetchFile(File, User, Product, EbicsOrderType, EbicsDownloadParams, boolean) with LocalDate values, which has no timezone in it.

Throws:

IOException

EbicsException

quit

public void quit()

Performs buffers save before quitting the client application.

clearTraces

public void clearTraces()

createEbicsClient

public static EbicsClient createEbicsClient(File rootDir,
 File configFile)
                                     throws IOException

Throws:

IOException

createDefaultUser

public void createDefaultUser()
                       throws Exception

Throws:

Exception

loadDefaultUser

public void loadDefaultUser()
                     throws Exception

Throws:

Exception

getDefaultUser

public User getDefaultUser()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception