| main | development |
|---|---|
 |
 |
The Unlaunch Java SDK provides a Java API to access Unlaunch feature flags and other features. Using the SDK, you can easily build Java applications that can evaluate feature flags, dynamic configurations, and more.
- To create feature flags to use with Java SDK, login to your Unlaunch Console at https://app.unlaunch.io
- Official Guide
- Javadocs
- MVN Repository
- Sonatype
Unlaunch Java SDK requires Java 8 or higher.
This SDK is server-side and should be used in applications that you run on your own servers such as backend services or web servers. For more information, see this.
Here is a simple example.
First, add the maven dependency to your project. Use the latest version from here.
<dependency>
<groupId>io.unlaunch.sdk</groupId>
<artifactId>unlaunch-java-sdk</artifactId>
<version>1.0.0</version>
</dependency>
Here's how you'd use the Java SDK in your application.
import io.unlaunch.UnlaunchClient;
public class ExampleApp {
public static void main(String[] args) {
// initialize the client
UnlaunchClient client = UnlaunchClient.create("INSERT_YOUR_SDK_KEY");
// wait for the client to be ready
try {
client.awaitUntilReady(2, TimeUnit.SECONDS);
} catch (InterruptedException | TimeoutException e) {
System.out.println("client wasn't ready " + e.getMessage());
}
// get variation
String variation = client.getVariation("FLAG_KEY", "userId123");
// take action based on the returned variation
if (variation.equals("on")) {
System.out.println("Variation is on");
} else if (variation.equals("off")) {
System.out.println("Variation is off");
} else {
System.out.println("control variation");
}
// If you attached (key-value) configuration to your feature flag variations,
// here's how you can retrieve it:
UnlaunchFeature feature = client.getFeature("FLAG_KEY", userId);
String colorHexCode = feature.getVariationConfig().getString("login_btn_clr", "#cd5c5c");
// shutdown the client to flush any events or metrics
client.shutdown();
}
}For more information, see the official guide.
- Java 8 or higher
- Maven 2 or higher
To build the project using maven, run the following command:
mvn clean install -Dgpg.skip
Note: Use -Dgpg.skip to bypass GPG keyphrase prompt. It is only needed for publishing to Maven Central repo.
To run all unit and integration tests:
mvn verify
If tests are failing, and you need to build (not recommended,) you can force to skip tests:
mvn clean install -Dmaven.test.skip=true -Dgpg.skip
You can use builder to customize the client. For more information, see the official guide.
UnlaunchClient client = UnlaunchClient.builder()
.sdkKey("INSERT_YOUR_SDK_KEY")
.pollingInterval(60, TimeUnit.SECONDS)
.eventsFlushInterval(30, TimeUnit.SECONDS)
.eventsQueueSize(500)
.metricsFlushInterval(30, TimeUnit.SECONDS)
.metricsQueueSize(100)
.build();
You can start the SDK in 'offline mode' for testing purposes. In the offline mode, flags aren't downloaded from the
server and no data is transferred. All calls to getVariation or its variants will return control. Read more in
the official guide.
To start the client in the offline mode for testing purposes, call the offlineMode method:
UnlaunchClient client = UnlaunchClient.builder().offlineMode().build();
Please see CONTRIBUTING to find how you can contribute.
Licensed under the Apache License, Version 2.0. See: Apache License.
To publish a new release version on Maven Central, there are two ways. Make sure you have -SNAPSHOT version in the pom file.
Create a new Git tag and let the ./deploy script do its job. You'll need to manually update the version in pom .xml after this is successful. Only do this on the main branch. For example, to release 0.0.3 version:
git tag 0.0.3
git push origin --tags
You must then update pom.xml version to be 0.0.4-SNAPSHOT. Commit your code to develop and PR into main.
Alternatively, you can also use the Maven Release plugin to deploy directly from your machine.
Helpful guides:
Unlaunch is a Feature Release Platform for engineering teams. Our mission is allow engineering teams of all sizes to release features safely and quickly to delight their customers. To learn more about Unlaunch, please visit www.unlaunch.io. You can sign up to get started for free at https://app.unlaunch.io/signup .
Answer: Please run export GPG_TTY=$(tty) See: keybase/keybase-issues#2798
Answer: The artifacts are published on Sonatype at: https://oss.sonatype.org/#nexus-search;quick~io.unlaunch.sdk
At Unlaunch, we are obsessed about making it easier for developers all over the world to release features safely and with confidence. If you have any questions or something isn't working as expected, please email [email protected].