garyzhao-ts/flagr-java

Java Client for Flagr

Flagr Java

An easy to use client for the Flagr feature flag service.

General Concepts used in this documentation

• Flag can be a feature flag or an experiment.
• Context is the information that needs to be provided to evaluate a flag.
• Variant represents the possible variation of a flag.
• Variant Attachment is additional meta information that you can return with your variant.

For more in depth information visit Flagr official docs.

Installation

Add the following dependency to pom.xml:

<dependencies>
    <dependency>
        <groupId>com.tradeshift</groupId>
        <artifactId>flagr-java</artifactId>
        <version>0.9.3</version>
    </dependency>
</dependencies>

Usage

Assume there's a flag called color for changing the blue background color of a page for a red one for 10% of the clients. Here is what the code for evaluating this flag would look like:

flagr = new Flagr(FLAGR_HOST);
try {
    EvaluationResponse response = flagr.evaluate(
        new EvaluationContext("background_color")
    );
    System.out.println(response.getVariantKey()); // The variant will be red for 10% of evaluations
} catch (FlagrException e) {
    e.printStackTrace();
}

If one of the clients is testing the red background and only this client is supposed to see the red background? The code above can send the client properties to Flagr so it knows about the client. Then on Flagr Admin UI you can specify that only your test client will see the red background. The code for this example would look like:

flagr = new Flagr(FLAGR_HOST);
try {
    EvaluationContext context = new EvaluationContext("background_color");
    context.setEntityContext(client); // Sends client info to Flagr so you can filter by one of it's properties on the UI.
    EvaluationResponse response = flagr.evaluate(context);
    System.out.println(response.getVariantKey()); // This would return red for the client(s) you select on Flagr UI.
} catch (FlagrException e) {
    e.printStackTrace();
}

If the variant needs properties as well, this can be achieved by creating a variant attachment and describing it's properties on Flagr UI. Suppose color has the properties name and hexadecimal, the code would look like:

flagr = new Flagr(FLAGR_HOST);
Client client = new Client("Søren", "Tradeshift");
try {
    EvaluationContext context = new EvaluationContext("background_color");
    context.setEntityContext(client); // Sends client info to Flagr so you can filter by one of it's properties on the UI.
    EvaluationResponse response = flagr.evaluate(context);
    Color color = response.getVariantAttachment(Color.class);
    System.out.println(response.getVariantKey(color.getName())); // This would return red for the client(s) you select on Flagr UI.
    System.out.println(response.getVariantKey(color.getHex())); // This would return #FF0000 for example.
} catch (FlagrException e) {
    e.printStackTrace();
}

If the values from EvaluationResponse class doesn't matter and only a Color is needed:

flagr = new Flagr(FLAGR_HOST);
Optional<Color> color = flagr.evaluateVariantAttachment(
        new EvaluationContext("color"),
        Color.class,
);
if (color.isPresent()){
    System.out.println(color.get().getName()); //do something with the color
}

When only the variant matters, use:

flagr = new Flagr(FLAGR_HOST);
Optional<String> variantKey = flagr.evaluateVariantKey(new EvaluationContext("myflag")));

And if it's just a simple on/off flag. Use the evaluateBoolean method. It returns true if the variant evaluates to "true", "enabled" or "on" otherwise it returns false.:

flagr = new Flagr(FLAGR_HOST);
if (flagr.evaluateEnabled(new EvaluationContext("onOffFlag"))) {
    System.out.println("Enabled!"); // or whatever needs to be done.
}

Versioning

We use SemVer for versioning.