This open source library allows you to A/B Test your Website at server-side.
The Java SDK supports:
- Open JDK 8, 9, 11, 12, 13, 15, 17
- Oracle JDK 8, 9, 11, 12, 13, 15, 17
Our Build is successful on these Java Versions - 8, 11, 12, 13, 15, 17
Install dependencies using mvn install
Add below Maven dependency in your project.
<dependency>
<groupId>com.vwo.sdk</groupId>
<artifactId>vwo-java-sdk</artifactId>
<version>LATEST</version>
</dependency>Refer Official VWO Documentation
GET SETTINGS FILE
Each VWO SDK client corresponds to the settingsFIle representing the current state of the campaign settings, that is, a list of server-side running campaign settings. Setting File is a pre-requisite for initiating the VWO CLIENT INSTANCE.
String settingsFile = VWO.getSettingsFile(accountId, sdkKey));INSTANTIATION
SDK provides a method to instantiate a VWO client as an instance. The method accepts an object to configure the VWO client. The mandatory parameter for instantiating the SDK is settingsFile.
import com.vwo.VWO;
VWO vwoInstance = VWO.launch(settingsFile).build();Activate API
String variationName = vwoClientInstance.activate(campaignKey, userId, options);
if (variationName.equals("Control")) {
// Write code for handling 'Control'
} else if (variationName.equals("Variation-1")) {
// CODE: write code for Variation-1
} else {
// CODE: When user does not become part of campaign.
}Track API
// For CUSTOM goal type
boolean isSuccessful = vwoClientInstance.track(campaignKey, userId, goalIdentifier, options);
// For REVENUE goal type
boolean isSuccessful = vwoClientInstance.track(campaignKey, userId, goalIdentifier, options);Feature Enabled API
Boolean isEnabled = vwoClientInstance.isFeatureEnabled(campaignKey, userId, options);
if (isEnabled) {
// Write code for handling feature enabled
} else {
// CODE: User is not qualified for the campaign. Would be due to configuring campaign's percent-traffic less than 100% while creating or updating a FullStack campaign.
}Get Variable Value API
Object value = vwoClientInstance.getFeatureVariableValue(campaignKey, variableKey, userId, options);Push API
boolean isSuccessful = vwoClientInstance.push(customDimensionKey, customDimensionValue, userId);The VWO client class needs to be instantiated as an instance that exposes various API methods like activate, getVariation and track.
USER STORAGE SERVICE
String settingsFile = VWO.getSettingsFile(accountId, sdkKey);
Storage.User userStorage = return new Storage.User() {
@Override
public Map<String, String> get(String userId, String campaignName) {
for (Map<String, String> savedCampaign: campaignStorageArray) {
if (savedCampaign.get("userId").equals(userId) && savedCampaign.get("campaignKey").equals(campaignName)) {
return savedCampaign;
}
}
return null;
}
@Override
public void set(Map<String, String> map){
campaignStorageArray.add(map);
}
};
VWO vwo = VWO.launch(settingsFile).withUserStorage(userStorage).build();LOGGER
JAVA SDK utilizes a logging facade, SL4J (https://www.slf4j.org/) as the logging api layer. If no binding is found on the class path, then you will see the following logs
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
You can get the SDK to log by providing a concrete implementation for SLF4J.
What it means is that at runtime, the logging implementation (or the logger binding) is missing , so slf4j simply use a "NOP" implementation, which does nothing.
If you need to output JAVA SDK logs, there are different approaches for the same.
SIMPLE IMPLEMENTATION If there are no implementation in your project , you may provide a simple implementation that does not require any configuration at all. Add following code to you pom.xml,
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.6.4</version>
</dependency>Now you see logging output on STDOUT with INFO level. This simple logger will default show any INFO level message or higher. In order to see DEBUG messages, you would need to pass -Dorg.slf4j.simpleLogger.defaultLogLevel=debug or simplelogger.properties file on the classpath See http://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.html for details
CONCRETE IMPLEMENTATION
sl4j supports various logging framework. Refer here ->https://www.slf4j.org/manual.html
We have provided our example with Logback If you have logback in your class path, to get console logs add following Appender and Logger in logback for formatted logs.
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>
%cyan(VWO-SDK) [%date] %highlight([%level]) %cyan([%logger{10} %file:%line]) %msg%n
</Pattern>
</encoder>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
</appender>
<Logger name="com.vwo.sdk" additivity="false">
<appender-ref ref="STDOUT"/>
</Logger>new VWOLogger(VWO.Enums.LOGGER_LEVEL.DEBUG.value()) {
@Override
public void trace(String message, Object... params) {
LOGGER.trace(message, params);
}
@Override
public void debug(String message, Object... params) {
LOGGER.debug(message, params);
}
@Override
public void info(String message, Object... params) {
LOGGER.info(message, params);
}
@Override
public void warn(String message, Object... params) {
LOGGER.warn(message, params);
}
@Override
public void error(String message, Object... params) {
LOGGER.error(message, params);
}
};For more appenders, refer this.
Refer third-party-attributions.txt
- Core Contributor & Maintainer - pntgupta
- Main Contributor - sakshimahendruvk
- Repo health maintainer - softvar
Refer CHANGELOG.md
Please go through our contributing guidelines
Copyright 2019-2022 Wingify Software Pvt. Ltd.