Worldline Connect Java SDK

Introduction

The Java SDK helps you to communicate with the Worldline Connect Server API. Its primary features are:

• convenient Java wrapper around the API calls and responses
  • marshalls Java request objects to HTTP requests
  • unmarshalls HTTP responses to Java response objects or Java exceptions
• handling of all the details concerning authentication
• handling of required metadata

Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.

See the Worldline Connect Developer Hub for more information on how to use the SDK.

Structure of this repository

This repository consists out of four main components:

1. The source code of the SDK itself: /src/main/java/ and /src/main/generated/
2. The source code of the SDK unit tests: /src/test/java/
3. The source code of the example integration tests: /src/it/java/
4. The source code of the example calls: /src/examples/java/

Installation

Assuming you have Maven installed, simply include the SDK as a Maven dependency:

<dependency>
  <groupId>com.worldline-solutions.connect</groupId>
  <artifactId>connect-sdk-java</artifactId>
  <version>x.y.z</version>
</dependency>

Alternatively, download the latest version of the SDK from GitHub. Choose the connect-sdk-java-x.y.z-bin.zip file from the releases page, where x.y.z is the version number. Add all JAR files inside the lib folder of this file to your project, except for connect-sdk-java-x.y.z-javadoc.jar and connect-sdk-java-x.y.z-sources.jar

Building the repository

This repository uses Maven to build. To build the SDK, execute the following command from its root directory (which contains the pom.xml file):

mvn -clean package

The build will generate the following files in the target directory, where x.y.z is the version number:

• connect-sdk-java-x.y.z.jar, containing the compiled class files
• connect-sdk-java-x.y.z-javadoc.jar, containing the generated Javadoc
• connect-sdk-java-x.y.z-sources.jar, containing the source code
• connect-sdk-java-x.y.z-src.zip, containing the contents of this folder
• connect-sdk-java-x.y.z-bin.zip, containing the necessary JAR files for standalone deployments and examples

To use it add all JAR files inside the lib folder of the connect-sdk-java-x.y.z-bin.zip file to your project, except for connect-sdk-java-x.y.z-javadoc.jar and connect-sdk-java-x.y.z-sources.jar.