Skip to main content

Java Cloud Server SDK Usage

Maven GitHub

DevCycleUser Object

The user object is required for all methods. The only required field in the user object is userId

See the DevCycleUser class in Java DevCycleUser model doc for all accepted fields.

DevCycleUser user = DevCycleUser.builder()
.userId("a_user_id")
.build();

Get and Use Variable By Key

This method will fetch a specific variable value by key for a given user. It will return the variable value from the server unless an error occurs or the server has no response. In that case it will return a variable value with the value set to whatever was passed in as the defaultValue parameter.

Boolean variableValue = client.variableValue(user, "turn_on_super_cool_feature", true);

if (variableValue.booleanValue()) {
// New Feature code here
} else {
// Old code here
}

The default value can be of type String, Boolean, Number, or Object.

If you would like to get the full Variable Object you can use variable() instead. This contains fields such as: key, value, type, defaultValue, isDefaulted.

Getting All Variables

This method will fetch all variables for a given user and returned as Map<String, Feature>

To get values from your Variables, the value field inside the variable object can be accessed.

Map<String, Variable> variables = client.allVariables(user);

Getting All Features

This method will fetch all features for a given user and return them as Map<String, Feature>

Map<String, Feature> features = client.allFeatures(user);

Track Event

To POST custom event for a user, pass in the user and event object.

DevCycleEvent event = DevCycleEvent.builder()
.date(Instant.now().toEpochMilli())
.target("test target")
.type("test event")
.value(new BigDecimal(600))
.build();

DevCycleResponse response = client.track(user, event);

EdgeDB

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about EdgeDB.

To get started, contact us at [email protected] to enable EdgeDB for your project.

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

import com.devcycle.sdk.server.cloud.api.DevCycleCloudClient;
import com.devcycle.sdk.server.cloud.model.DevCycleCloudOptions;

import com.devcycle.sdk.server.common.model.DevCycleUser;
import com.devcycle.sdk.server.common.model.Variable;

DevCycleUser user = DevCycleUser.builder()
.userId("test_user")
.country("US")
.email("[email protected]")
.build();

DevCycleUser onlyUserId = DevCycleUser.builder()
.userId("test_user");

DevCycleCloudOptions devcycleOptions = DevCycleCloudOptions.builder()
.enableEdgeDB(true)
.build();

private DevCycleCloudClient devcycleClient;

public MyClass() {
devcycleClient = new DevCycleCloudClient("<DEVCYCLE_SERVER_SDK_KEY>", devcycleOptions);

Boolean testBoolean = devcycleClient.variableValue(user, "test-boolean-variable", false);

String onlyCountry = devcycleClient.variableValue(onlyUserId, "test-string-country-variable", "Not Available");
}

This will send a request to our EdgeDB API to save the custom data under the user test_user.

In the example, Email and Country are associated to the user test_user. In your next identify call for the same userId, you may omit any of the data you've sent already as it will be pulled from the EdgeDB storage when segmenting to experiments and features.

Override Logging

The SDK logs to stdout by default and does not require any specific logging package. To integrate with your own logging system, such as Java Logging or SLF4J, you can create a wrapper that implements the IDevCycleLogger interface. Then you can set the logger into the Java Server SDK setting the Custom Logger property in the options object used to initialize the client.

IDevCycleLogger loggingWrapper = new IDevCycleLogger() {
@Override
public void debug(String message) {
// Your logging implementation here
}

@Override
public void info(String message) {
// Your logging implementation here
}

@Override
public void warning(String message) {
// Your logging implementation here
}

@Override
public void error(String message) {
// Your logging implementation here
}

@Override
public void error(String message, Throwable throwable) {
// Your logging implementation here
}
};

// Set the logger in the options before creating the DevCycleCloudClient
DevCycleCloudOptions options = DevCycleCloudOptions.builder().customLogger(loggingWrapper).build();