JarCastingConfigCat SDK for Java
ConfigCat SDK for Java provides easy integration for your application to ConfigCat.
ConfigCat is a feature flag and configuration management service that lets you separate feature releases from code deployments. You can turn features ON or OFF using the ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email, or any other custom user attribute.
ConfigCat is a hosted feature flag service that lets you manage feature toggles across frontend, backend, mobile, and desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
Getting started
1. Install the ConfigCat SDK
Maven:
<dependency>
<groupId>com.configcat</groupId>
<artifactId>configcat-java-client</artifactId>
<version>[6.0.0,)</version>
</dependency>
Gradle:
compile group: 'com.configcat', name: 'configcat-java-client', version: '6.+'
2. Go to the Connect your applications tab to get your SDK Key:
3. Import com.configcat.* in your application code
import com.configcat.*;
4. Create a ConfigCat client instance
ConfigCatClient client = new ConfigCatClient("#YOUR-SDK-KEY#");
5. Get the setting's value:
boolean isMyAwesomeFeatureEnabled = client.getValue(Boolean.class, "isMyAwesomeFeatureEnabled", false);
if(isMyAwesomeFeatureEnabled) {
doTheNewThing();
} else{
doTheOldThing();
}
Or use the async APIs:
client.getValueAsync(Boolean.class, "isMyAwesomeFeatureEnabled", false)
.thenAccept(isMyAwesomeFeatureEnabled -> {
if(isMyAwesomeFeatureEnabled) {
doTheNewThing();
} else{
doTheOldThing();
}
});
Getting user-specific setting values with Targeting
Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the getValue() function.
Read more about Targeting here.
User Object
Percentage and targeted rollouts are calculated by the user object passed to the configuration requests. The user object must be created with a mandatory identifier parameter which uniquely identifies each user:
User user = User.newBuilder()
.build("#USER-IDENTIFIER#"); // mandatory
boolean isMyAwesomeFeatureEnabled = client.getValue(Boolean.class, "isMyAwesomeFeatureEnabled", user, false);
if(isMyAwesomeFeatureEnabled) {
doTheNewThing();
} else{
doTheOldThing();
}
Sample/Demo app
Polling Modes
The ConfigCat SDK supports three different polling mechanisms to acquire the setting values from ConfigCat. After the latest setting values are downloaded, they are stored in an internal cache . After that, all requests are served from the cache. Read more about Polling Modes and how to use them at ConfigCat Java Docs or ConfigCat Android Docs.
Support
If you need help using this SDK, feel free to contact the ConfigCat Staff at https://configcat.com. We're happy to help.
Contributing
Contributions are welcome.
