Skip to main content

Java SDK

With the Kameleoon Java SDK, you can run experiments and activate feature flags on your Java EE application server.

Follow the Getting started section to walk through the installation process. To jump right into the code, see the SDK reference. We also recommend reading the technical considerations article to learn the general concepts behind our SDKs.

Latest version of the Java SDK: 4.1.0 (changelog).

Getting started

Follow this section to install and configure the iOS SDK in your iOS app.

Install the Java client

The package is available from the Maven Central repository. You can install the Java SDK by adding a dependency into your project's pom.xml file, as shown in the example to the right. If you're using another project management system, see the integrations page for additional examples.

pom.xml
<dependency>
<groupId>com.kameleoon</groupId>
<artifactId>kameleoon-client-java</artifactId>
<version>4.1.0</version>
</dependency>

Additional configuration

Create a .properties configuration file to provide credentials and customize the SDK behavior. You can also download our sample configuration file.

We recommend saving this file to the default path of /etc/kameleoon/client-java.conf, but you can save it anywhere in the classpath as kameleoon-client-java.properties.

The following table shows the available properties that you can set:

KeyDescription
client_idRequired for authentication to the Kameleoon service. To find your client_id, see the API credentials documentation.
client_secretRequired for authentication to the Kameleoon service. To find your client_secret, see the API credentials documentation.
session_duration_minuteDesignates the predefined time interval that Kameleoon stores the visitor and their associated data in memory (RAM). Note that increasing the session duration increases the amount of RAM that needs to be allocated to store visitor data. The default session duration is 30 minutes.
refresh_interval_minuteSpecifies the refresh interval, in minutes, that the SDK fetches the configuration for the active experiments and feature flags. The value determines the maximum time it takes to propagate changes, such as activating or deactivating feature flags or launching experiments, to your production servers. If left unspecified, the default interval is set to 60 minutes. Additionally, we offer a streaming mode that uses server-sent events (SSE) to push new configurations to the SDK automatically and apply new configurations in real-time, without any delays.
default_timeout_millisecondSpecifies the timeout, in milliseconds, for network requests from the SDK. Set the value to 30 seconds or more if you do not have a stable connection. The default value is 10000 ms. Some methods have an additional parameter that you can use to override the default timeout for that particular method. If you do not specify the timeout for a method explicitly, the SDK uses this default value.
environmentEnvironment from which a feature flag’s configuration is to be used. The value can be production, staging, development. The default environment value is production. See the managing environments article for details.
top_level_domainThe current top-level domain for your website . Use the format: example.com. Don't include https://, www, or other subdomains. Kameleoon uses this information to set the corresponding cookie on the top-level domain. This field is mandatory.
proxy_hostSets the proxy host for all outgoing server calls made by the SDK.

Initialize the Kameleoon client

After you've installed the SDK into your application and configured your credentials and SDK behavior (in /etc/kameleoon/client-java.conf), the next step is to create the Kameleoon client in your application code. For example:

import com.kameleoon.KameleoonClientFactory;

String siteCode = "a8st4f59bj";

try {
KameleoonClient kameleoonClient = KameleoonClientFactory.create(siteCode, "custom/file/path/client-java.properties");
} catch (KameleoonException.SiteCodeIsEmpty e) {
// indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
// indicates that provided clientId / clientSecret are not valid
}

try {
KameleoonClientConfig config = new KameleoonClientConfig.Builder()
.clientId("<clientId>") // mandatory
.clientSecret("<clientSecret>") // mandatory
.configurationRefreshInterval(60) // in minutes, optional (60 minutes by default)
.sessionDuration(30) // in minutes, optional (30 minutes by default)
.defaultTimeout(10_000) // in milliseconds, optional (10000 ms by default)
.topLevelDomain("example.com") // mandatory if you use hybrid mode (engine or web experiments)
.environment("development") // optional
.proxyHost(new HttpHost("192.168.0.25", 8080, "http")) // optional
.build();
KameleoonClientFactory.create(siteCode, config);
} catch (KameleoonException.SiteCodeIsEmpty e) {
// indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
// indicates that provided clientId / clientSecret are not valid
}

A KameleoonClient is a singleton object that acts as a bridge between your application and the Kameleoon platform. It includes all the methods and properties you need to run an experiment. Note that we also support the use of an HTTP proxy in the Java SDK (see the create() method reference for details).

note

It's your responsibility as the app developer to ensure the proper logic of your application code within the context of A/B testing via Kameleoon. A good practice is to always assume that you can exclude the current visitor from the experiment if the experiment has not yet been launched. This is actually easy to do, because this corresponds to the implementation of the default and reference variation logic.

You're now ready to begin creating and implementing experiments and feature flagging.

Reference

This is the full reference documentation for the Java SDK.

If this is your first time working with the Java SDK, see the Getting started section to integrate the SDK into your app.

com.kameleoon.KameleoonClientFactory

create

The starting point for using the SDK is the initialization step. Your app conducts all interactions with the SDK through an object of the KameleoonClient class. Create this object using the static method create() in KameleoonClientFactory.

Arguments
NameTypeDescription
siteCodeStringKameleoon site code of the website you want to run experiments on. You can find this unique code ID in the Kameleoon app. This field is required.
configurationPathStringPath to the SDK configuration file. This field is optional and set to /etc/kameleoon/client-java.conf by default.
kameleoonConfigKameleoonClientConfigConfiguration SDK object that you can pass instead of using a configuration file. This field is optional.
proxyHostHttpHostAllows your app to set an HTTP proxy for all the network calls made by the SDK. This field is optional. This field is optional. If not specified, the SDK uses a proxy specified in the configuration file. If the configuration file doesn't contain a proxy, no proxy will be used.
Return value
TypeDescription
KameleoonClientAn instance of the KameleoonClient class that your app can then use to manage your experiments and feature flags.
Exceptions thrown
TypeDescription
KameleoonException.ConfigCredentialsInvalidException indicating that the requested credentials were not provided (either in the configuration file or as arguments to the method).
KameleoonException.SiteCodeIsEmptyException indicating that the specified site code is empty string which is invalid value.
Example code
import com.kameleoon.KameleoonClientFactory;

String siteCode = "a8st4f59bj";

try {
KameleoonClient kameleoonClient = KameleoonClientFactory.create(siteCode, "custom/file/path/client-java.properties");
} catch (KameleoonException.SiteCodeIsEmpty e) {
// indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
// indicates that provided clientId / clientSecret are not valid
}

try {
KameleoonClientConfig config = new KameleoonClientConfig.Builder()
.clientId("<clientId>") // mandatory
.clientSecret("<clientSecret>") // mandatory
.configurationRefreshInterval(60) // in minutes, optional (60 minutes by default)
.sessionDuration(30) // in minutes, optional (30 minutes by default)
.defaultTimeout(10_000) // in milliseconds, optional (10000 ms by default)
.topLevelDomain("example.com") // mandatory if you use hybrid mode (engine or web experiments)
.environment("development") // optional
.proxyHost(new HttpHost("192.168.0.25", 8080, "http")) // optional
.build();
KameleoonClientFactory.create(siteCode, config);
} catch (KameleoonException.SiteCodeIsEmpty e) {
// indicates that provided site code is empty
} catch (KameleoonException.ConfigCredentialsInvalid exception) {
// indicates that provided clientId / clientSecret are not valid
}

com.kameleoon.KameleoonClient

getVisitorCode

note

This method was previously named obtainVisitorCode, which was removed in SDK version 4.0.0.

The getVisitorCode() helper method should be called to obtain the Kameleoon visitorCode for the current visitor. This is especially important when using Kameleoon in a mixed front-end and back-end environment, where user identification consistency must be guaranteed. The implementation logic is described here:

  1. First we check if a kameleoonVisitorCode cookie or query parameter associated with the current HTTP request can be found. If so, we will use this as the visitor identifier.

  2. If no cookie / parameter is found in the current request, we either randomly generate a new identifier, or use the defaultVisitorCode argument as identifier if it is passed. This allows our customers to use their own identifiers as visitor codes, should they wish to. This can have the added benefit of matching Kameleoon visitors with their own users without any additional look-ups in a matching table.

  3. In any case, the server-side (via HTTP header) kameleoonVisitorCode cookie is set with the value. Then this identifier value is finally returned by the method.

For more information, refer to this article.

note

If you provide your own visitorCode, its uniqueness must be guaranteed on your end - the SDK cannot check it. Also note that the length of visitorCode is limited to 255 characters. Any excess characters will throw an exception.

Arguments
NameTypeDescription
httpServletRequestHttpServletRequestThe current HttpServletRequest object should be passed as the first parameter. This field is mandatory.
httpServletResponseHttpServletResponseThe current HttpServletResponse object should be passed as the second parameter. This field is mandatory.
defaultVisitorCodeStringThis parameter will be used as the visitorCode when an existing kameleoonVisitorCode cookie is not found on the request. This field is optional. If not specified, the SDK generates a random visitorCode when no existing kameleoonVisitorCode cookie.
Return value
TypeDescription
StringA visitorCode that will be associated with this particular user and should be used with most of the methods of the SDK.
Example code
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);

String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse, userID);

String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse, UUID.randomUUID().toString());

isFeatureActive

note

This method was previously named activeFeature, which was removed in SDK version 4.0.0.

Call this method to check whether a feature flag should be active for a specified user. This method takes a visitorCode and a featureKey as mandatory arguments to check if the feature is active for the specified user.

If the user has never been associated with this feature flag, the SDK returns a random boolean value (either true to add the user to this feature or false to exclude them from the feature). If a user with the specified visitorCode is already registered with this feature flag, the SDK detects the previous featureFlagvalue.

Make sure you catch and handle potential exceptions.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.
featureKeyStringKey of the feature that you want to check the status of for the user. This field is required.
Return value
TypeDescription
booleanValue of the feature that is registered for the specified `visitorCode.
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException indicating that the requested feature ID wasn't found in the internal configuration of the SDK. This usually means that the feature flag has not yet been activated on Kameleoon's side (but code that implements the feature is already deployed in the application).
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
Example code
String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
String featureKey = "new_checkout";
Boolean hasNewCheckout = false;

try {
hasNewCheckout = kameleoonClient.isFeatureActive(visitorCode, featureKey);
}
catch (KameleoonException.FeatureNotFound e) {
// Feature toggle not yet activated on Kameleoon's side - we consider the feature inactive
hasNewCheckout = false;
}
catch (Exception e) {
// This is a generic exception handler that handles all exceptions.
System.out.println("Exception occurred");
}
if (hasNewCheckout)
{
// Implement new checkout code here
}

getFeatureVariationKey

Call this method to get the feature variation key for a specified user and feature. This method takes a visitorCode and featureKey as mandatory arguments to get the variation key for the specified user.

If the user has never been associated with this feature flag, the SDK returns a randomly-assigned variation key (according to the feature flag rules). If a user with the specified visitorCode is already registered with this feature flag, the SDK detects the previous variation key value. If the user doesn't match any of the rules, the default value is returned, which you can customize in the Kameleoon app.

Make sure you catch and handle potential exceptions.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.
featureKeyStringKey of the feature you want to expose to a user. This field is required.
Return value
TypeDescription
StringVariation key of the feature flag that is registered for the specified visitorCode.
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException indicating that the requested feature key wasn't found in the internal configuration of the SDK. This usually means that the feature flag is not activated in the Kameleoon app (but code implementing the feature is already deployed on your application).
KameleoonException.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid. It is empty or longer than 255 characters.
Example code
String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
String featureKey = "new_checkout";
String variationKey = ""

try {
variationKey = kameleoonClient.GetFeatureVariationKey(visitorCode, featureKey);
} catch (KameleoonException.FeatureNotFound e) {
// The error has happened, the feature flag isn't found in current configuration
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
// The feature flag is disabled for the environment
} catch (KameleoonException.VisitoCodeNotValid e) {
// The visitor code you passed to the method is invalid and can't be accepted by SDK
}

switch (variationKey) {
case 'on':
// Main variation key is selected for visitorCode
break;
case 'alternative_variation':
// Alternative variation key
break;
default:
// Default variation key
break;
}

getFeatureVariable

Call this method to get the feature variation value associated with a user. This method takes a visitorCode, featureKey and variableKey as required arguments to get the variable of the variation key for the specified user.

If a user has never been associated with this feature flag, the SDK returns a randomly assigned variable value of the variation key, in accordance with the feature flag rules. If a user with the specified visitorCode is already registered with this feature flag, the SDK returns the variable value for previously associated variation. If the user does not match any of the rules, the default variable is returned.

Make sure you catch and handle potential exceptions.

Arguments
NameTypeDescription
visitorCodestringUnique identifier of the user. This field is required.
featureKeystringKey of the feature you want to expose to a user. This field is required.
variableKeystringName of the variable you want to get a value for. This field is required.
Return value
TypeDescription
objectValue of variable of variation that is registered for the specified visitorCode for this feature flag. Possible types: bool, int, double, string, JObject, JArray
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException indicating that the requested feature key wasn't found in the internal SDK configuration. This usually means that the feature flag has not yet been activated in the Kameleoon app (but code implementing the feature is already deployed in your application).
KameleoonException.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
KameleoonException.FeatureVariableNotFoundException indicating that the requested variable wasn't found. Check that the variable's key in the Kameleoon app matches the one in your code.
KameleoonException.VisitorCodeInvalidException indicating that the specified visitor code is not valid. (It is either empty or longer than 255 characters).
Example code
String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
String featureKey = "feature_key";
String variableKey = "var"

try {
var variableValue = kameleoonClient.getFeatureVariable(visitorCode, featureKey, variableKey);
// Your custom code depending on variableValue
} catch (KameleoonException.FeatureNotFound e) {
// The error has occurred, the feature flag isn't found in current configuration
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
// The feature flag is disabled for the environment
} catch (KameleoonException.FeatureVariableNotFound e) {
// Requested variable not defined on Kameleoon's side
} catch (KameleoonException.VisitoCodeNotValid e) {
// The visitor code passed to the method is invalid and can't be accepted by SDK
}

getFeatureVariables

Retrieves a map containing variable keys and their values assigned according the variation that the visitor is assigned to in the specified feature flag. Feature variables can be easily modified through the Kameleoon app.

If a user has never been associated with this feature flag, the SDK returns a randomly assigned set of variable values in the variation, in accordance with the feature flag rules. If a user with the specified visitorCode is already registered with this feature flag, the SDK returns the variable values for the variation used previously. If the user does not match any of the rules, the default variables are returned.

Make sure you catch and handle potential exceptions.

Arguments
NameTypeDescription
featureKeyStringKey of the feature you want to obtain. This field is required.
variationKeyStringKey of the variation you want to obtain. This field is required.
Return value
TypeDescription
Map<String,Object>Data associated with this feature flag. The values can be Boolean, Integer, Double, String, JsonObject, or JsonArray (the type is defined in the Kameleoon app).
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException indicating that the requested feature key wasn't found in the internal SDK configuration. This usually means that the feature flag has not yet been activated in the Kameleoon app (but code implementing the feature is already deployed in your application).
KameleoonException.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
KameleoonException.FeatureVariationNotFoundException indicating that the requested variation key wasn't found in the internal configuration of the SDK. This usually means that the variation's corresponding experiment is not activated in the Kameleoon app.
KameleoonException.VisitorCodeInvalidException indicating that the specified visitor code is not valid. (It is either empty or longer than 255 characters).
Example code
String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
String featureKey = "feature_key";
String variableKey = "var"

try {
var variableValue = kameleoonClient.getFeatureVariables(visitorCode, featureKey);
// Your custom code depending on variable values
} catch (KameleoonException.FeatureNotFound e) {
// The error has occurred, the feature flag isn't found in current configuration
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
// The feature flag is disabled for the environment
} catch (KameleoonException.FeatureVariableNotFound e) {
// Requested variable not defined on Kameleoon's side
} catch (KameleoonException.VisitoCodeNotValid e) {
// The visitor code passed to the method is invalid and can't be accepted by SDK
}

getFeatureVariationVariables

note

This method was previously named: getFeatureAllVariables, which was removed in SDK version 4.0.0.

Call this method to retrieve all feature variables for a feature. You can modify feature variables in the Kameleoon app.

This method takes two input parameters: featureKey and variationKey. It returns the data with the Map<String, Object> type, as defined in the Kameleoon app. It throws an exception (KameleoonException.FeatureNotFound) if the requested feature isn't found in the internal configuration of the SDK.

Arguments
NameTypeDescription
featureKeyStringKey of the feature you want to obtain. This field is required.
variationKeyStringKey of the variation you want to obtain. This field is required.
Return value
TypeDescription
Map<String,Object>Data associated with this feature flag. The values can be Boolean, Integer, Double, String, JsonObject, JsonArray (depending on the type defined in the Kameleoon app).
Exceptions thrown
TypeDescription
KameleoonException.FeatureNotFoundException indicating that the requested feature wasn't found in the internal configuration of the SDK. This usually means that the feature flag is not activated in the Kameleoon app.
KameleoonException.FeatureEnvironmentDisabledException indicating that feature flag is disabled for the visitor's current environment (for example, production, staging, or development).
KameleoonException.FeatureVariationNotFoundException indicating that the requested variation key wasn't found in the internal configuration of the SDK. This usually means that the variation's corresponding experiment is not activated in the Kameleoon app.
Example code
String featureKey = "featureKey";
String variationKey = "variationKey";

try {
Map<String, Object> allVariables = kameleoonClient.getFeatureVariationVariables(featureKey, variationKey);
}
catch (KameleoonException.FeatureNotFound e) {
// The feature is not yet activated in the Kameleoon app
} catch (KameleoonException.FeatureEnvironmentDisabled e) {
// The feature flag is disabled for the environment
} catch (KameleoonException.FeatureVariationNotFound e) {
// The variation is not yet activated in the Kameleoon app (most likely, the associated experiment is not active)
} catch (Exception e) {
// This is a generic Exception handler which will handle all exceptions.
System.out.println("Exception occurred");
}

trackConversion

Use this method to track a conversion for a specific goal and user. This method requires visitorCode and goalID. In addition, this method also accepts an optional revenue argument to track revenue generated by the conversion. The visitorCode is usually identical to the one that was used when triggering the experiment.

The trackConversion() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.
goalIDintID of the goal. This field is required.
revenuefloatRevenue of the conversion. This field is optional.
Example code
String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
int goalID = 83023;

kameleoonClient.addData(visitorCode, Browser.CHROME);
kameleoonClient.addData(
visitorCode,
new PageView("https://url.com", "title", Array.asList(3)),
new Interest(2)
);
kameleoonClient.addData(visitorCode, new Conversion(32, 10f, false));

kameleoonClient.trackConversion(visitorCode, goalID);

addData

The addData() method adds targeting data to storage so other methods can use the data to decide whether or not to target the current visitor.

The addData() method does not return any value and does not interact with Kameleoon back-end servers on its own. Instead, all the declared data is saved for future transmission using the flush method. This approach reduces the number of server calls made, as the data is typically grouped into a single server call that is triggered the flush. Note that the trackConversion method also sends out any previously associated data, just like the flush method. The same is true for getFeatureFlagVariationKey and getFeatureFlagVariable methods if an experimentation rule is triggered.

tip

Each visitor can only have one instance of associated data for most data types. However, CustomData is an exception. Visitors can have one instance of associated CustomData per customDataIndex.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.
dataTypesDataCustom data types which may be passed separated by a comma.
Example code
kameleoonClient.addData(visitorCode, Browser.CHROME);
kameleoonClient.addData(
visitorCode,
new PageView("https://url.com", "title", Array.asList(3)),
new Interest(0)
);
kameleoonClient.addData(visitorCode, new Conversion(32, 10f, false));

flush

Data associated with the current user via addData() method is not sent immediately to the server. It is stored and accumulated until it is sent automatically by the trackConversion() methods or manually by the flush() method. This allows the developer to control exactly when the data is flushed to our servers. For instance, if you call the addData() method a dozen times, it would be a waste of resources to send data to the server after each addData() invocation. Just call flush() once at the end.

The flush() method doesn't return anything. This method is non-blocking as the server call is made asynchronously.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.

getFeatureList

note

This method was previously named obtainFeatureList, which was removed in SDK version 4.0.0.

Returns a list of feature flag keys currently available for the SDK

Return value
TypeDescription
List<String>List of feature flag keys
Example code
List<String> allFeatureFlagKey = kameleoonClient.getFeatureList();

getActiveFeatureListForVisitorCode

note

This method was previously named obtainFeatureListForVisitorCode, which was removed in SDK version 4.0.0.

This method takes a single visitorCode parameter. Return only the active feature flags for the specified visitor.

Arguments
NameTypeDescription
visitorCodeStringUnique identifier of the user. This field is required.
Return value
TypeDescription
List<String>List of active feature flag keys available for specific visitorCode
Example code
List<String> listActiveFeatureFlags = kameleoonClient.getActiveFeatureListForVisitorCode(visitorCode);

getRemoteData

note

This method was previously named retrieveDataFromRemoteSource, which was removed in SDK version 4.0.0.

The getRemoteData() method allows you to retrieve data (according to a key passed as argument) for the specified siteCode stored on a remote Kameleoon server. Your site code was specified in KameleoonClientFactory.create()) Usually data is stored on our remote servers using our Data API. This method, along with the availability of our highly scalable servers, provides a convenient way to quickly store additional data that you can later retrieve for your app.

Arguments
NameTypeDescription
keystringThe key that is associated with the data you want to get. This field is mandatory.
Return value
TypeDescription
CompletableFuture<JsonObject>Future JsonObject associated with retrieving data for specific key.
Example code
CompletableFuture<JsonObject> data = kameleoonClient.getRemoteData("key");

try {
JsonObject test = kameleoonClient.getRemoteData("key").get(5_000, TimeUnit.MILLISECONDS);
} catch (InterruptedException | ExecutionException | TimeoutException e) {
// Catch exception
}

getRemoteVisitorData

The getRemoteVisitorData() method allows you to retrieve data assigned to a visitor (according to a visitorCode passed as argument) for specified siteCode (specified in KameleoonClientFactory.create()) stored on a remote Kameleoon server. Method automatically adds retrieved data for a visitor (according to a addData parameter). Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.

Arguments
NameTypeDescription
visitorCodestringThe visitor code for which you want to retrieve the assigned data. This field is mandatory.
addDatabooleanA boolean indicating whether the method should automatically add retrieved data for a visitor.. This field is optional.
Return value
TypeDescription
CompletableFuture<List<Data>>Future List<Data> associated with a given visitor.
Example code
String visitorCode = "visitorCode";
// Visitor data will be fetched and automatically added for `visitorCode`
CompletableFuture<List<Data>> visitorData = kameleoonClient.getRemoteVisitorData(visitorCode);

// If you only want to fetch data and add it yourself manually, set addData == `false`
CompletableFuture<List<Data>> visitorData = kameleoonClient.getRemoteVisitorData(visitorCode, false);

try {
List<Data> visitorData = kameleoonClient.getRemoteVisitorData(visitorCode).get(5_000, TimeUnit.MILLISECONDS);
// Your custom code
} catch (CancellationException | InterruptedException | ExecutionException | TimeoutException e) {
// Catch exception
}

getVisitorWarehouseAudience

Retrieves all audience data associated with the visitor in your data warehouse using the specified visitorCode and warehouseKey. The warehouseKey is typically your internal user ID. The customDataIndex parameter corresponds to the Kameleoon custom data that Kameleoon uses to target your visitors. You can refer to the warehouse targeting documentation for additional details. The method passes the result to the returned future as a CustomData object, confirming that the data has been added to the visitor and is available for targeting purposes.

Arguments
NameTypeDescription
visitorCodeStringThe unique identifier of the visitor for whom you want to retrieve and add the data.
warehouseKeyStringThe unique key to identify the warehouse data (usually, your internal user ID). This field is optional.
customDataIndexintAn integer representing the index of the custom data you want to use to target your BigQuery Audiences.
Return value
TypeDescription
CompletableFuture<CustomData>Future CustomData instance confirming that the data has been added to the visitor.
Exceptions thrown
TypeDescription
VisitorCodeInvalidException indicating that the provided visitor code is not valid (it is either empty or longer than 255 characters).
Example code
CompletableFuture<CustomData> warehouseAudienceDataCF =
kameleoonClient.getVisitorWarehouseAudience(visitorCode, warehouseKeyValue, customDataIndex);

// If you need to specify warehouse key
CompletableFuture<CustomData> warehouseAudienceDataCF =
kameleoonClient.getVisitorWarehouseAudience(visitorCode, customDataIndex);

try {
CustomData warehouseAudienceData = warehouseAudienceDataCF.get(5_000, TimeUnit.MILLISECONDS);
// Your custom code
} catch (CancellationException | InterruptedException | ExecutionException | TimeoutException e) {
// Catch exception
}

updateConfigurationHandler

Use this method to handle the event when the configuration has updated data. It takes one input parameter handler, which is the handler that will be called when the configuration is updated using a real-time configuration event.

Arguments
NameTypeDescription
handlerKameleoonUpdateConfigurationHandlerThe handler that will be called when the configuration is updated using a real-time configuration event.
Example code
kameleoonClient.updateConfigurationHandler(() -> {
// Configuration was updated
});

getEngineTrackingCode

Kameleoon offers built-in integrations with several analytics solutions, including Mixpanel, GA4, and Segment. To ensure that you can track and analyze your server-side experiments, Kameleoon provides the method getEngineTrackingCode() to automatically send exposure events to the analytics solution you are using. For more information on how to implement this method, please refer to hybrid experimentation documentation.

note

To benefit from this feature, you need to implement both the Java SDK and our Kameleoon JavaScript tag. We recommend you implement the Kameleoon Asynchronous tag, which you can install before your closing <body> tag in your HTML page, as it will be only used for tracking purposes.

Arguments
NameTypeDescription
visitorCodeStringThe user's unique identifier. This field is required.
Return value
TypeDescription
StringJavasScript code to be inserted in your page.
Example code
String engineTrackingCode = kameleoonClient.getEngineTrackingCode(visitorCode);
// The following string will be returned:
//
// window.kameleoonQueue = window.kameleoonQueue || [];
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment1ID, variation1ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment1ID, true]);
// window.kameleoonQueue.push(['Experiments.assignVariation', experiment2ID, variation2ID]);
// window.kameleoonQueue.push(['Experiments.trigger', experiment2ID, true]);
//
// Here, experiment1ID, experiment2ID and variation1ID, variation2ID represent
// the specific experiments and variations that users have been assigned to.

setLegalConsent

You must use this method to specify whether the visitor has given legal consent to use personal data. Setting the legalConsent parameter to false limits the types of data that you can include in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information on personal data in the Consent management policy.

Arguments
NameTypeDescription
visitorCodeStringThe user's unique identifier. This field is required.
legalConsentbooleanA boolean value representing the legal consent status. true indicates the visitor has given legal consent, false indicates the visitor has never provided, or has withdrawn, legal consent. This field is required.
responseHttpServletResponseThe HTTP servlet response where values in the cookies will be adjusted based on the legal consent status. The field is optional.
Exceptions thrown
TypeDescription
KameleoonException.VisitorCodeInvalidException indicating that the provided visitor code is not valid. It is either empty or longer than 255 characters.
Example code
// if you do not need to set the visitor code in a cookie to respond
kameleoonClient.setLegalConsent(visitorCode, true);

String visitorCode = kameleoonClient.getVisitorCode(httpServletRequest, httpServletResponse);
kameleoonClient.setLegalConsent(visitorCode, true, httpServletResponse);

com.kameleoon.Data

This section lists the data types supported by Kameleoon. We provide several standard data types as well as the CustomData type that allows you to define custom data types.

Browser

Store the user's browser.

NameTypeDescription
browserBrowser.TypeList of browsers: CHROME, INTERNET_EXPLORER, FIREFOX, SAFARI, OPERA, OTHER. This field is required.
versionfloatVersion of browser. This field is optional.
kameleoonClient.addData(visitorCode, Browser.chrome());
kameleoonClient.addData(visitorCode, Browser.safari());

kameleoonClient.addData(visitorCode, new Browser(Browser.Type.CHROME, 10.0));

PageView

Store page view events.

NameTypeDescription
urlStringURL of the page viewed. This field is required.
titleStringTitle of the page viewed. This field is required.
referrersList<Integer>Referrers of viewed pages. This field is optional.
note

The index (ID) of the referrer is available in the Kameleoon app, in the Acquisition channel configuration page. Be careful: this index starts at 0, so the first acquisition channel you create for the specified site would have the ID 0, not 1.
https://help.kameleoon.com/create-acquisition-channel

kameleoonClient.addData(
visitorCode,
new PageView("https://url.com", "title", Array.asList(3))
);

Conversion

Store conversion data.

NameTypeDescription
goalIDintID of the goal. This field is required.
revenuefloatConversion revenue. This field is optional.
negativebooleanDefines if the revenue is positive or negative. This field is optional.
kameleoonClient.addData(visitorCode, new Conversion(32, 10f, false));

CustomData

Define your own custom data types in the Kameleoon app or the Data API and use them from the SDK.

NameTypeDescription
indexintIndex / ID of the custom data to be stored. This field is required.
valueString... or List<String>Value of the custom data to be stored. This field is required.
note

The index (ID) of the custom data is available in the Kameleoon app, in the Custom data configuration page. Be careful, this index starts at 0 so the first custom data you create for the specified site would have the ID 0, not 1.

kameleoonClient.addData(visitorCode, new CustomData(1, "some custom value"));

kameleoonClient.addData(visitorCode, new CustomData(1, "first value", "second value"));

Device

NameTypeDescription
deviceDeviceList of devices: PHONE, TABLET, DESKTOP. This field is required.
kameleoonClient.addData(visitorCode, Device.desktop());

UserAgent

Store information on the user-agent of the visitor. Server-side experiments are more vulnerable to bot traffic than client-side experiments. To address this, Kameleoon uses the IAB/ABC International Spiders and Bots List to identify known bots and spiders. Kameleoon also uses the UserAgent field to filter out bots and other unwanted traffic that could otherwise skew your conversion metrics. For more details, see the help article on Bot filtering.

If you use internal bots, we suggest that you pass the value curl/8.0 of the userAgent to exclude them from our analytics.

NameTypeDescription
valueStringThe User-Agent value that will be sent with tracking requests. This field is required.
kameleoonClient.addData(visitorCode, new UserAgent("Your User Agent"));

LegalConsent

You must use this method to specify whether the visitor has given legal consent to use personal data. Setting the given parameter to false limits the types of data that you can include in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information on personal data in the consent management policy.

NameTypeDescription
givenbooleanIndicates whether or not the visitor gave legal consent to use personal data. This field is required.
kameleoonClient.addData(visitorCode, new LegalConsent(true));