/java-client

LaunchDarkly SDK for Java

Primary LanguageJavaOtherNOASSERTION

LaunchDarkly SDK for Java

Circle CI

Quick setup

  1. Add the Java SDK to your project

     <dependency>
   <groupId>com.launchdarkly</groupId>
   <artifactId>launchdarkly-client</artifactId>
   <version>2.0.10</version>
 </dependency>

  2. Import the LaunchDarkly package:

     import com.launchdarkly.client.*;

  3. Create a new LDClient with your SDK key:

     LDClient ldClient = new LDClient("YOUR_SDK_KEY");

Your first feature flag

  1. Create a new feature flag on your dashboard

  2. In your application code, use the feature's key to check wthether the flag is on for each user:

     LDUser user = new LDUser(username);
 boolean showFeature = ldClient.boolVariation("your.feature.key", user, false);
 if (showFeature) {
   // application code to show the feature 
 }
 else {
   // the code to run if the feature is off
 }

Logging

The LaunchDarkly SDK uses SLF4J. For an example configuration check out the hello-java project.

Be aware of two considerations when enabling the DEBUG log level:

  1. Debug-level logs can be very verbose. It is not recommended that you turn on debug logging in high-volume environments.
  2. Potentially sensitive information is logged including LaunchDarkly users created by you in your usage of this SDK.

Learn more

Check out our documentation for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the complete reference guide for this SDK or our Javadocs.

Testing

We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.

Contributing

We encourage pull-requests and other contributions from the community. We've also published an SDK contributor's guide that provides a detailed explanation of how our SDKs work.

About LaunchDarkly