IBM Cloud App Configuration Java server SDK

IBM Cloud App Configuration SDK is used to perform feature flag and property evaluation based on the configuration on IBM Cloud App Configuration service.

Overview
Installation
Import the SDK
Initialize SDK
License

Overview

IBM Cloud App Configuration is a centralized feature management and configuration service on IBM Cloud for use with web and mobile applications, microservices, and distributed environments.

Instrument your applications with App Configuration Java SDK, and use the App Configuration dashboard, CLI or API to define feature flags or properties, organized into collections and targeted to segments. Toggle feature flag states in the cloud to activate or deactivate features in your application or environment, when required. You can also manage the properties for distributed applications centrally.

Installation

maven

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>appconfiguration-java-sdk</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle

implementation group: 'com.ibm.cloud', name: 'appconfiguration-java-sdk', version: '0.1.1'

Import the SDK

import com.ibm.cloud.appconfiguration.sdk.AppConfiguration;

Initialize SDK

AppConfiguration appConfiguration = AppConfiguration.getInstance();

String region = "region";
String guid = "guid";
String apikey = "apikey";

appConfiguration.init(region, guid, apikey);

String collectionId = "airlines-webapp";
String environmentId = "dev";

appConfiguration.setContext(collectionId, environmentId);

region : Region name where the service instance is created. Use
- AppConfiguration.REGION_US_SOUTH for Dallas
- AppConfiguration.REGION_EU_GB for London
- AppConfiguration.REGION_AU_SYD for Sydney
guid : GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard
apikey : ApiKey of the App Configuration service. Get it from the service instance credentials section of the dashboard
collectionId : Id of the collection created in App Configuration service instance under the Collections section.
environmentId : Id of the environment created in App Configuration service instance under the Environments section.

Here, by default live update from the server is enabled. To turn off this mode see the below section

Work offline with local configuration file

You can also work offline with local configuration file and perform feature and property related operations.

String configurationFile = "saflights/flights.json";
Boolean liveConfigUpdateEnabled = false;

appConfiguration.setContext(collectionId, environmentId, configurationFile, liveConfigUpdateEnabled);

configurationFile : Path to the JSON file which contains configuration details.
liveConfigUpdateEnabled : Set this value to false if the new configuration values shouldn't be fetched from the server. Make sure to provide a proper JSON file in the configurationFile path. By default, this value is enabled.

Permissions required by SDK

Add write permission for non-root users to appconfiguration.json file which is used as cache in AppConfiguration SDK.

Get single feature

Feature feature = appConfiguration.getFeature("online-check-in");

if (feature) {
    System.out.println("Feature Name : " + feature.getFeatureName());
    System.out.println("Feature Id : " + feature.getFeatureId());
    System.out.println("Feature Type : " + feature.getFeatureDataType());
    System.out.println("Feature is enabled : " + feature.isEnabled());
}

Get all features

HashMap<String, Feature> features = appConfiguration.getFeatures();

Evaluate a feature

You can use the feature.getCurrentValue(entityId, entityAttributes) method to evaluate the value of the feature flag.

You should pass an unique entityId as the parameter to perform the feature flag evaluation. If the feature flag is configured with segments in the App Configuration service, you can set the attributes values as a JSONObject.

String entityId = "john_doe";
JSONObject entityAttributes = new JSONObject();
entityAttributes.put("city", "Bangalore");
entityAttributes.put("country", "India");

String value = (String) feature.getCurrentValue(entityId, entityAttributes);

Get single property

Property property = appConfiguration.getProperty("check-in-charges");

if (property) {
    System.out.println("Property Name : " + property.getPropertyName());
    System.out.println("Property Id : " + property.getPropertyId());
    System.out.println("Property Type : " + property.getPropertyDataType());
}

Get all properties

HashMap<String, Property> property = appConfiguration.getProperties();

Evaluate a property

You can use the property.getCurrentValue(entityId, entityAttributes) method to evaluate the value of the property.

You should pass an unique entityId as the parameter to perform the property evaluation. If the property is configured with segments in the App Configuration service, you can set the attributes values as a JSONObject.

String entityId = "john_doe";
JSONObject entityAttributes = new JSONObject();
entityAttributes.put("city", "Bangalore");
entityAttributes.put("country", "India");

String value = (String) property.getCurrentValue(entityId, entityAttributes);

Set listener for feature or property data changes

To listen to the data changes add the following code in your application.

appConfiguration.registerConfigurationUpdateListener(new ConfigurationUpdateListener() {
    @Override
    public void onConfigurationUpdate() {
       System.out.println("Got feature/property now");
    }
});

Fetch latest data

appConfiguration.fetchConfigurations();

Enable debugger (Optional)

appConfiguration.enableDebug(True);

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE

srikanthkm/appconfiguration-java-sdk