Experiment JVM SDK

1implementation "com.amplitude:experiment-jvm-server:<VERSION>"

1implementation("com.amplitude:experiment-jvm-server:<VERSION>")

1fun initializeRemote(
2    apiKey: String,
3    config: RemoteEvaluationConfig = RemoteEvaluationConfig()
4): RemoteEvaluationClient

1@Nonnull
2public RemoteEvaluationClient initializeRemote(
3    @Nonnull String apiKey,
4    @Nonnull RemoteEvaluationConfig config
5);

1val experiment = Experiment.initializeRemote("<DEPLOYMENT_KEY>")

1RemoteEvaluationClient experiment = Experiment.initializeRemote("<DEPLOYMENT_KEY>");

1fun fetch(user: ExperimentUser): CompletableFuture<Map<String, Variant>>

1@Nonnull
2public CompletableFuture<Map<String, Variant>> fetch(@Nonnull ExperimentUser user);

 1val user = ExperimentUser.builder()
 2    .userId("user@company.com")
 3    .deviceId("abcdefg")
 4    .userProperty("premium", true)
 5    .build()
 6val variants = try {
 7    experiment.fetch(user).get()
 8} catch (e: Exception) {
 9    e.printStackTrace()
10    return
11}

 1ExperimentUser user = ExperimentUser.builder()
 2    .userId("user@company.com")
 3    .deviceId("abcdefg")
 4    .userProperty("premium", true)
 5    .build();
 6Map<String, Variant> variants;
 7try {
 8    variants = experiment.fetch(user).get();
 9} catch (Exception e) {
10    e.printStackTrace();
11    return;
12}

1val variant = variants["<FLAG_KEY>"]
2if (variant?.value == "on") {
3    // Flag is on
4} else {
5    // Flag is off
6}

1Variant variant = variants.get("<FLAG_KEY>");
2if (Variant.valueEquals(variant, "on")) {
3    // Flag is on
4} else {
5    // Flag is off
6}

1implementation "com.amplitude:experiment-jvm-server:<VERSION>"

1implementation("com.amplitude:experiment-jvm-server:<VERSION>")

1fun initializeLocal(
2    apiKey: String,
3    config: LocalEvaluationConfig = LocalEvaluationConfig(),
4): LocalEvaluationClient

1@Nonnull
2public LocalEvaluationClient initializeLocal(
3    @Nonnull String apiKey,
4    @Nonnull LocalEvaluationConfig config
5);

1fun start()

1public void start();

1fun stop()

1public void stop();

1fun evaluate(user: ExperimentUser, flagKeys: List<String> = listOf()): Map<String, Variant>

1@Nonnull
2public Map<String, Variant> evaluate(@Nonnull experimentUser, @Nonnull List<String> flagKeys);

 1// The user to evaluate
 2val user = ExperimentUser.builder()
 3    .userId("user@company.com")
 4    .deviceId("abcdefg")
 5    .userProperty("premium", true)
 6    .build()
 7 
 8// Evaluate all flag variants
 9val allVariants = experiment.evaluate(user)
10 
11// Evaluate a specific subset of flag variants
12val specificVariants = experiment.evaluate(user, listOf(
13    "<FLAG_KEY_1>",
14    "<FLAG_KEY_2>",
15))
16 
17// Access a variant
18val variant = allVariants["<FLAG_KEY>"]
19if (variant?.value == "on") {
20    // Flag is on
21} else {
22    // Flag is off
23}

 1// The user to evaluate
 2ExperimentUser user = ExperimentUser.builder()
 3    .userId("user@company.com")
 4    .deviceId("abcdefg")
 5    .userProperty("premium", true)
 6    .build();
 7 
 8// Evaluate all flag variants
 9Map<String, Variant> allVariants = experiment.evaluate(user);
10 
11// Evaluate a specific subset of flag variants
12Map<String, Variant> specificVariants = experiment.evaluate(user,
13    List.of("<FLAG_KEY_1>", "<FLAG_KEY_2>"));
14 
15// Access a variant
16Variant variant = allVariants.get("<FLAG_KEY>");
17if (Variant.valueEquals(variant, "on")) {
18    // Flag is on
19} else {
20    // Flag is off
21}

1val experiment = Experiment.initializeLocal(
2    "<DEPLOYMENT_KEY>",
3    // (Recommended) Enable local evaluation cohort targeting.
4    LocalEvaluationConfig.builder()
5        .cohortSyncConfig(CohortSyncConfig("<API_KEY>", "<SECRET_KEY>"))
6        .build()
7)

1// (1) Initialize the local evaluation client with a server deployment key.
2LocalEvaluationClient experiment = Experiment.initializeLocal("<DEPLOYMENT_KEY>",
3    // (Recommended) Enable local evaluation cohort targeting.
4    LocalEvaluationConfig.builder()
5        .cohortSyncConfig(new CohortSyncConfig("<API_KEY>", "<SECRET_KEY>"))
6        .build());