Package org.confng.sources

Class ConsulConfigSource

java.lang.Object

org.confng.sources.ConsulConfigSource

All Implemented Interfaces:

ConfigSource

public class ConsulConfigSource
extends Object
implements ConfigSource

Configuration source that fetches configuration from HashiCorp Consul KV store.

This source connects to a Consul agent and retrieves configuration values from the key-value store under a specified prefix.

Example Usage:

 // Simple usage with default localhost:8500
 ConsulConfigSource source = new ConsulConfigSource("myapp/config");
 ConfNG.addSource(source);
 
 // With custom Consul address and ACL token
 ConsulConfigSource source = ConsulConfigSource.builder()
     .host("consul.example.com")
     .port(8500)
     .prefix("myapp/config")
     .aclToken("your-acl-token")
     .build();
 ConfNG.addSource(source);
 

Since:

1.1.0

Author:

Bharat Kumar Malviya, GitHub: github.com/imBharatMalviya

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsulConfigSource.Builder

Constructor Summary

Constructors

Constructor	Description
ConsulConfigSource(String prefix)	Creates a new Consul config source with default settings.
ConsulConfigSource(String host, int port, String prefix, String aclToken, boolean useSsl, int connectTimeoutMs, int readTimeoutMs, long cacheTimeoutMs, int priority)	Creates a new Consul config source with custom settings.
ConsulConfigSource(String host, int port, String prefix, String aclToken, boolean useSsl, int connectTimeoutMs, int readTimeoutMs, long cacheTimeoutMs, int priority, int maxRetries, long retryDelayMs)	Creates a new Consul config source with custom settings including retry configuration.

Method Summary

Modifier and Type	Method	Description
static ConsulConfigSource.Builder	builder()	Builder for creating ConsulConfigSource instances.
Optional<String>	get(String key)	Retrieves a configuration value for the given key.
String	getName()	Returns the name of this configuration source.
int	getPriority()	Returns the priority of this configuration source.
void	refresh()	Forces a refresh of the cached configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsulConfigSource

public ConsulConfigSource(String prefix)

Creates a new Consul config source with default settings.

Parameters:

prefix - the key prefix to fetch (e.g., "myapp/config")

ConsulConfigSource

public ConsulConfigSource(String host,
                          int port,
                          String prefix,
                          String aclToken,
                          boolean useSsl,
                          int connectTimeoutMs,
                          int readTimeoutMs,
                          long cacheTimeoutMs,
                          int priority)

Creates a new Consul config source with custom settings.

ConsulConfigSource

public ConsulConfigSource(String host,
                          int port,
                          String prefix,
                          String aclToken,
                          boolean useSsl,
                          int connectTimeoutMs,
                          int readTimeoutMs,
                          long cacheTimeoutMs,
                          int priority,
                          int maxRetries,
                          long retryDelayMs)

Creates a new Consul config source with custom settings including retry configuration.

Method Detail

getName

public String getName()

Description copied from interface: ConfigSource

Returns the name of this configuration source.

Specified by:

getName in interface ConfigSource

Returns:

the source name, never null

get

public Optional<String> get(String key)

Description copied from interface: ConfigSource

Retrieves a configuration value for the given key.

If the key is not found in this source, an empty Optional should be returned. This allows the ConfNG system to try other sources in the resolution chain.

Specified by:

get in interface ConfigSource

Parameters:

key - the configuration key to look up

Returns:

an Optional containing the value if found, empty otherwise

getPriority

public int getPriority()

Description copied from interface: ConfigSource

Returns the priority of this configuration source.

Sources with higher priority values are consulted first in the resolution chain. Default priorities:

• 100+ - Secret managers and secure sources
• 80-99 - TestNG parameters and test-specific sources
• 60-79 - Environment variables
• 40-59 - System properties
• 20-39 - Configuration files (JSON, Properties)
• 0-19 - Default and fallback sources

Specified by:

getPriority in interface ConfigSource

Returns:

the priority value, higher values have higher priority

refresh

public void refresh()

Forces a refresh of the cached configuration.

builder

public static ConsulConfigSource.Builder builder()

Builder for creating ConsulConfigSource instances.