Java API Reference

Flagger

init

public static void init(FlaggerInitConfig config)

init method gets FlaggerConfiguration, establishes and maintains SSE connections and initializes Ingester

Note: init must be called only once, at the start of your application. Your program must wait for init to finish before using any other Flagger methods

import io.airdeploy.flagger.*;

public class Main {

    public static void main(String[] args) {
        String apiKey = "<API-KEY>";
        FlaggerInitConfig flaggerInitConfig = FlaggerInitConfig.builder()
                .apiKey(apiKey) // could be omitted if FLAGGER_API_KEY env variable is set
                .logLevel(LogLevel.DEBUG) // could be omitted, ERROR by default
                .build();
        Flagger.init(flaggerInitConfig);


        // rest of the app code goes here
        boolean enabled = Flagger.isEnabled("group-messaging", Entity.builder().id("57145770").build());

        System.out.println(enabled);
    }
}
nameEnvironment variableDefaultDescription
apiKeyFLAGGER_API_KEYNoneAPI key to an environment
sourceURLFLAGGER_SOURCE_URLhttps://flags.airdeploy.io/v3/config/URL to get FlaggerConfiguration
backupSourceURLFLAGGER_BACKUP_SOURCE_URLhttps://backup-api.airshiphq.com/v3/config/backup URL to get FlaggerConfiguration
sseURLFLAGGER_SSE_URLhttps://sse.airdeploy.io/v3/sse/URL for real-time updates of FlaggerConfiguration via sse
ingestionURLFLAGGER_INGESTION_URLhttps://ingestion.airdeploy.io/v3/ingest/URL for ingestion
logLevelFLAGGER_LOG_LEVELERRORset up log level: ERROR, WARN, DEBUG. Debug is the most verbose level and includes all Network requests
  • If not provided default arguments values are used and printed to Debug
  • If second(third …) call of init happens:
    • If the arguments are the same, init method does nothing
    • If arguments differ, Flagger prints warnings and recreates(closes and creates new) resources(SSE connection, Ingester, gets new FlaggerConfiguration).

    • Note: you must call init only once

  • If initial FlaggerConfiguration is not fetched from source/backup, Flagger prints a warning
  • If Flagger fails to get FlaggerConfiguration then all Flags Functions return Default Variation
  • If Flagger fails to establish SSE connection, it retries every 30 seconds until succeeded
  • If you call any Flag Function BEFORE init is finished then you'll get Default Variation

shutdown

public static boolean shutdown(int timeoutMillis)

shutdown ingests data(if any), stops ingester and closes SSE connection. shutdown waits until current ingestion request is finished, but no longer than a timeoutMillis.

returns true if closed by timeout

Note: you must call shutdown only once before the end of the application runtime.

Flagger.shutdown(5000)

publish

public static void publish(Entity entity)

Explicitly notify Airdeploy about an Entity

Attributes attributes = new Attributes().put("age", 40);
Flagger.publish(Entity.builder().id("37").attributes(attributes).build());

track

public static void track(Event event) {

Event tracking API. Entity is an optional parameter if it was set before.

Attributes eventProperties = new Attributes()
    .put("plan", "gold")
    .put("referrer", "www.google.com")
    .put("shirt_size", "medium");
Event event = Event.builder().name("Purchase Completed")
    .eventProperties(eventProperties)
    .entity(Entity.builder()
                    .id("37")
                    .build())
    .build();
Flagger.track(event);

setEntity

public static void setEntity(Entity entity)

setEntity stores an entity in Flagger, which allows omission of entity in other API methods.

Entity entity = Entity.builder().id(whiteListedEntityUserId).build();

Flagger.setEntity(entity);
boolean enabled = Flagger.isEnabled(flagCodenameWhitelisted, null);

Assert.assertTrue(enabled);
//clean up
Flagger.setEntity(null);

If you don't provide any entity to Flagger:

  • flag functions always resolve with the default variation
  • track method doesn't record an event

Rule of thumb: make sure you always provide an entity to the Flagger

isEnabled

public static boolean isEnabled(String codename, Entity entity)

Determines if flag is enabled for entity.

boolean enabled = Flagger.isEnabled("test", Entity.builder().id("id").build());

Group example:

Entity company = Entity.builder()
                .id("random")
                .group(GroupEntity.builder().id("companyId").type("Company").build()).build();
boolean enabledCompany = Flagger.isEnabled("some-flag", company);

isSampled

public static boolean isSampled(String codename, Entity entity)

Determines if entity is within the targeted subpopulations

boolean isSampled = Flagger.isSampled("show_wallet", generateEntity());

Group example:

Entity company = Entity.builder()
                .id("random")
                .group(GroupEntity.builder().id("companyId").type("Company").build()).build();
boolean isSampled = Flagger.isSampled("show_wallet", company)

getVariation

public static String getVariation(String codename, Entity entity)

Returns the variation assigned to the entity in a multivariate flag

String variation = Flagger.getVariation("show_wallet", generateEntity());

Group example:

Entity company = Entity.builder()
                .id("random")
                .group(GroupEntity.builder().id("companyId").type("Company").build()).build();

String variation = Flagger.getVariation("show_wallet", company);

getPayload

public static Map<String, Object> getPayload(String codename, Entity entity)

Returns the payload associated with the treatment assigned to the entity

Map<String, Object> payload = Flagger.getPayload("show_new_dashboard", someEntity);

Group example:

Entity company = Entity.builder()
                .id("random")
                .group(GroupEntity.builder().id("companyId").type("Company").build()).build();

Map<String, Object> payload = Flagger.getPayload("show_new_dashboard", company);
← ReactRuby →