LaunchKey SDK for Java


This SDK version deprecated as the API version this SDK requires will be retired in the near future. Please refer the the current version of LaunchKey Service SDK for Java.

Use this SDK to interact with the LaunchKey Platform API in your Java application. This documentation explains how to use the SDK in the most common scenarios. The full documentation of the SDK can be found in the Javadocs.

Before you can begin using the Platform API, you need an service. If you have not created an service yet, you can use our Help Center to learn how to create one.


Provide Cryptography Pre-Requisites

Before you can use the LaunchKey Platform SDK, you must update your Java Runtime Environment (JRE) for some requirements of the Java Cryptography Extension (JCE) to allow the Platform SDK for Java to encrypt, decrypt, sign, and verify data transferred between your service and the Platform API.

JCE Unlimited Strength Jurisdiction Policy Files

Install the "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" for your JRE version. If you installed your JRE via a package manager, there will usually be a package for the JCE as well. If not, download the JAR for your JRE and follow the installation instructions.

JCE Cryptography Provider

Follow the instructions for your installing cryptography provider.

We recommend the Bouncy Castle JCE provider. Installation consists of:

  1. Download the JAR file for the Bouncy Castle cryptography provider from

    Maven Central here.

  2. Place the JAR file in the lib/ext directory of the JRE.

Obtain the SDK

The LaunchKey Platform SDK is available via standard Maven artifact repositories. Multiple dependency management systems allow for using Maven artifact repositories.

  • Group ID: com.launchkey.sdk
  • Artifact ID: launchkey-sdk

Create a Client Factory

The client factory contains all of the pieces and parts for creating a client. To simplify the process of building the client factory, we have provided a client factory builder. The ClientFactoryBuilder provides a number of methods to customize the ClientFactory. A few common examples are below.

Example using a specific JCE provider:

ClientFactory clientFactory = new ClientFactoryBuilder()
    .setJCEProvider(new BouncyCastleProvider())

Example using a custom Apache HTTP client:

HttpClient httpClient = HttpClients.createDefault();
ClientFactory clientFactory = new ClientFactoryBuilder()
    .setJCEProvider(new BouncyCastleProvider())

User Contributed

LaunchKey links to user contributed code as a resource to its community. LaunchKey does not in any way guarantee or warrant the quality and security of these code bases. User contributed code is supported by the creators. If you do find a link from the site to user contributed code that is malicious or inappropriate in any way, please report that link to LaunchKey immediately and we will investigate the claim. Submit any issue to LaunchKey support at ×