Java SDK installation

Control feature rollout for certain user segments of your application with feature flags. To start using feature management in the platform, follow the instructions below to install the SDK and deploy a feature flag.

Install the SDK

Follow these steps to install the SDK:

Select Feature management Installation.
Select an Environment from the options, or create an environment by completing the following:
1. Select Create environment.
2. Enter an Environment name.
3. (Optional) Enter a Description.
4. (Optional) Select Approvers if you want to have a manual approval required before deployment.
5. (Optional) Enter any Properties you want to associate with the environment. For more information, refer to properties configuration and properties in an environment.
6. Select Submit.
Select Java from the language options.
Select a package manager from the options.

Add the ROX package to your application by running the shell commands appropriate for your package manager, listed in the following table:

Table 1. Commands to add the ROX package to your application
Package manager	Commands to run
Maven	`<dependency> <groupId>io.rollout.rox</groupId> <artifactId>rox-java-server</artifactId> <version>6.0.0</version> </dependency>` ▼
Gradle	`implementation 'io.rollout.rox:rox-java-server:6.0.0'

Add the following code to your Java application:

Your SDK key is a unique environment identifier. During SDK installation, the SDK key is displayed within the Rox.setup call.

import io.rollout.rox.server.Rox;
import io.rollout.rox.server.RoxFlag;
import java.util.concurrent.ExecutionException;

public class Main {
    public static void main(String[] args) throws InterruptedException, ExecutionException {
        // Initialize Flags container class
        Flags flags = new Flags();

        // Register the flags container under a namespace
        Rox.register("default", flags);

        // Setup connection with the feature management environment key
        Rox.setup("<YOUR-SDK-KEY>").get();(1)

        // Prints the value of the Boolean enableTutorial flag
        System.out.printf("enableTutorial value is %s%n", flags.enableTutorial.isEnabled() ? "true" : "false");
    }
}

// Define the Flags class
class Flags {
    public RoxFlag enableTutorial = new RoxFlag();
}▼

1	The platform provides the unique SDK key for your environment at the `<YOUR-SDK-KEY>` location within the `Rox.setup` call.

Run the application and test the integration

Follow these steps to test the integration:

Run your application.
In the CloudBees platform, select Test integration to verify the SDK connection.

After running the application, flags added in the code are automatically added to your feature flag list.

You have installed an SDK and created flags in your application.

Refer to the SDK reference for more information.

Download the code for link: an example Spring Boot application with feature flags.