Skip to main content

Getting Started with Java SDK

The DinoConfig Java SDK provides a robust, thread-safe way to access your configurations from any Java application. The v2.0 API returns values directly with no wrapper objects needed.

Prerequisites​

  • Java 21 or higher
  • Maven or Gradle build tool
  • A DinoConfig API key (get one from dinoconfig.com)

Installation​

Gradle​

Add the dependency to your build.gradle:

dependencies {
    implementation 'com.dinoconfig:dinoconfig-java-sdk:2.0.0'
}

Maven​

Add the dependency to your pom.xml:

<dependency>
    <groupId>com.dinoconfig</groupId>
    <artifactId>dinoconfig-java-sdk</artifactId>
    <version>2.0.0</version>
</dependency>

Quick Start​

1. Create and Initialize the SDK​

import com.dinoconfig.sdk.DinoConfigSDK;
import com.dinoconfig.sdk.DinoConfigSDKFactory;

// Simple initialization
DinoConfigSDK sdk = DinoConfigSDKFactory.create(
    "dino_your-api-key-here",
    "https://api.dinoconfig.com"
);

2. Fetch Configuration Values​

// Get a single value with type safety - returns the value directly!
String theme = sdk.getConfigAPI().getValue("MyBrand.AppSettings.theme", String.class);
System.out.println(theme); // "dark"

// Get an entire configuration - returns ConfigData directly
ConfigData config = sdk.getConfigAPI().get("MyBrand.AppSettings");
System.out.println(config.getValues()); // {theme=dark, maxItems=100, ...}

3. Explore Available Configurations​

// List all brands you have access to - returns List<BrandInfo> directly
List<BrandInfo> brands = sdk.getDiscoveryAPI().listBrands();
for (BrandInfo brand : brands) {
    System.out.println(brand.getName() + ": " + brand.getConfigCount() + " configurations");
}

// List configurations for a brand
List<ConfigInfo> configs = sdk.getDiscoveryAPI().listConfigs("MyBrand");
for (ConfigInfo config : configs) {
    System.out.println(config.getName() + " - " + config.getKeys());
}

Basic Example​

Here's a complete example of using the SDK:

import com.dinoconfig.sdk.DinoConfigSDK;
import com.dinoconfig.sdk.DinoConfigSDKFactory;
import com.dinoconfig.sdk.model.ConfigData;

public class App {
    public static void main(String[] args) {
        // Initialize the SDK
        DinoConfigSDK sdk = DinoConfigSDKFactory.create(
            System.getenv("DINOCONFIG_API_KEY"),
            "https://api.dinoconfig.com"
        );

        try {
            // Get application settings - returns ConfigData directly
            ConfigData settings = sdk.getConfigAPI().get("MyApp.Settings");
            
            System.out.println("App Name: " + settings.getValue("appName", String.class));
            System.out.println("Max Users: " + settings.getValue("maxUsers", Integer.class));
            System.out.println("Version: " + settings.getVersion());

            // Get a specific feature flag with type safety
            Boolean darkMode = sdk.getConfigAPI().getValue(
                "MyApp.FeatureFlags.darkModeEnabled", 
                Boolean.class
            );
            
            if (Boolean.TRUE.equals(darkMode)) {
                System.out.println("Dark mode is enabled!");
            }
        } catch (Exception e) {
            System.err.println("Error fetching config: " + e.getMessage());
        }
    }
}

Environment Variables​

We recommend storing your API key in environment variables:

export DINOCONFIG_API_KEY=dino_your-api-key-here
export DINOCONFIG_BASE_URL=https://api.dinoconfig.com
DinoConfigSDK sdk = DinoConfigSDKFactory.create(
    System.getenv("DINOCONFIG_API_KEY"),
    System.getenv("DINOCONFIG_BASE_URL")
);
Security Note

Never commit your API keys to version control. Always use environment variables or a secrets manager in production.

SDK Structure​

The SDK provides two main APIs through the initialized instance:

APIDescription
ConfigAPIRetrieve configuration values
DiscoveryAPIExplore brands, configs, and schemas
DinoConfigSDK sdk = DinoConfigSDKFactory.create("dino_...", "https://api.dinoconfig.com");

// Access the APIs
ConfigAPI configApi = sdk.getConfigAPI();
DiscoveryAPI discoveryApi = sdk.getDiscoveryAPI();

Factory Methods​

The DinoConfigSDKFactory provides multiple creation methods:

// API key only (uses default base URL)
DinoConfigSDK sdk = DinoConfigSDKFactory.create("dino_key");

// API key with custom base URL
DinoConfigSDK sdk = DinoConfigSDKFactory.create("dino_key", "https://api.dinoconfig.com");

// API key, base URL, and timeout
DinoConfigSDK sdk = DinoConfigSDKFactory.create("dino_key", "https://api.dinoconfig.com", 15000L);

// Using configuration object (most flexible)
DinoConfigSDKConfig config = DinoConfigSDKConfig.builder()
    .apiKey("dino_key")
    .baseUrl("https://api.dinoconfig.com")
    .timeout(15000L)
    .build();
DinoConfigSDK sdk = DinoConfigSDKFactory.create(config);

Thread Safety​

The SDK is designed to be thread-safe after initialization:

// Create once at application startup
public class Application {
    private static final DinoConfigSDK SDK = DinoConfigSDKFactory.create(
        System.getenv("DINOCONFIG_API_KEY"),
        "https://api.dinoconfig.com"
    );
    
    public static DinoConfigSDK getSdk() {
        return SDK;
    }
}

// Safe to use from multiple threads
ExecutorService executor = Executors.newFixedThreadPool(10);
for (int i = 0; i < 100; i++) {
    executor.submit(() -> {
        ConfigData config = Application.getSdk().getConfigAPI().get("Brand.Config");
        // Process config...
    });
}

What's Next?​