- Documentation

Java SDK

This section describes how to set up and install the Java SDK and how to deploy a feature flag.

Getting started with Java SDK

Step 1: Setting up

To setup Java SDK, follow these steps:

  1. A Rollout account. See Signup Page to create an account.

  2. An Application created in the Rollout dashboard.

    • The first time you log into your account, click the Create New App button to create a new app.
  1. An environment key.
    • Get the key from App Settings > Environment > Key

Step 2: Installing the Java Server SDK

Add the CloudBees Rollout Java Server package to your application

Add the following in the dependencies block:

# Add the Rollout SDK to your application
implementation 'io.rollout.rox:rox-java-server:4.+'


Create a container class called with the following code

This container class is where we will define all of our feature flags

import io.rollout.flags.RoxFlag;
import io.rollout.configuration.RoxContainer;

// Create Roxflags in the Flags container class
public class Flags implements RoxContainer {
  // Define the feature flags
  public RoxFlag enableTutorial = new RoxFlag(false);
  public RoxVariant titleColors = new RoxVariant("White", new String[] {"White", "Blue", "Green"});

Add the following lines of code to your application.

// Initialize container class that we created earlier
Flags flags = new Flags();

// Register the flags container with Rollout

// Setup the Rollout environment key

// Boolean flag example
if (flags.enableTutorial.isEnabled()) {
  // TODO:  Put your code here that needs to be gated 

// Multivariate flag example
if (flags.titleColors.value().equals("White")) {
  Log.i(tag, "Title color is white");
} else if (flags.titleColors.value().equals("Blue")) {
  Log.i(tag, "Title color is blue");
} else if (flags.titleColors.value().equals("Green")) {
  Log.i(tag, "Title color is green");

Container class registration and environment key setup

  • The Rox.register() function must be called before the Rox.setup() function.

  • You can not call Rox.setup() twice in the same runtime.

Run your application.

Running the project

The Flag name is automatically added to the Rollout dashboard after running the application.

Step 3: Deploying a feature flag

Finding your flags in the Rollout dashboard

After creating feature flags and running your feature code, you can find your flags in the Rollout dashboard.

To find your flags in the Rollout dashboard:

  1. Find your app in the Rollout dashboard
    To switch between apps, click on the app name in the top-left corner of the screen and select the app you want from the pulldown.

  2. Click on Flags on the left side of the navigation panel.

  3. Confirm that your flag is listed in the flag view.

Configuring deployment rules

  1. Go to Rollout's dashboard.
  2. Click on Experiments on the left panel.
  3. Click the Create Experiment button to create a new experiment.
  4. In the New Experiment window:
    • Find the Flag name from the menu, choose it.
    • Click the Set Audience button to continue. The Experiment Details view appears.
  5. Select either True, False, Split or Scheduled. Split allows you to select the percentage of the target group that you want to deploy. Scheduled allows you to schedule a deployment date.
  1. Click Update Audience.


  • You can not delete the default condition.
  • You can click the Reset link to go back to the state from before you started making changes. Reset only appears when you've made saved modifications.

See Audience for more detailed information.

Updated 19 days ago

What's Next


Java SDK

This section describes how to set up and install the Java SDK and how to deploy a feature flag.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.