Class CconfigClientImpl

java.lang.Object

org.chenile.cconfig.sdk.impl.CconfigClientImpl

All Implemented Interfaces:

CconfigClient

public class CconfigClientImpl
extends Object
implements CconfigClient

The default implementation of the CconfigClient interface. This uses registered CconfigRetriever instances to get multiple Cconfigs that allow the default value to be mutated.

Field Summary

Fields

Modifier and Type	Field	Description
private final CconfigRetrieverFactory	cconfigRetrieverFactory
(package private) ContextContainer	contextContainer
private static final org.slf4j.Logger	logger
(package private) MemoryCache	memoryCache

Constructor Summary

Constructors

Constructor	Description
CconfigClientImpl(String configPath, CconfigRetrieverFactory cconfigRetrieverFactory)

Method Summary

Modifier and Type	Method	Description
private Map<String,Object>	allKeysForModule(String module, String customAttribute)
protected String	customizationAttribute()	Override this in a subclass to change the default behaviour.
Map<String,Object>	value(String module, String key)

Methods inherited from class Object

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

Field Details

logger

private static final org.slf4j.Logger logger

cconfigRetrieverFactory

private final CconfigRetrieverFactory cconfigRetrieverFactory

memoryCache

@Autowired
MemoryCache memoryCache

contextContainer

@Autowired
ContextContainer contextContainer

Constructor Details

CconfigClientImpl

public CconfigClientImpl(String configPath,
 CconfigRetrieverFactory cconfigRetrieverFactory)

Method Details

value

public Map<String,Object> value(String module,
 String key)

Specified by:

value in interface CconfigClient

Parameters:

module - - the module under which the key is defined. Modules can be nested.

key - - the key for which value is desired.

Returns:

the value for the key. If key is null and only module name is specified, then all keys for module will be returned. Key value can be string or a map.
If a module is specified it will be a map with all the keys as keys of the map. The value can be strings or map depending on how the value was defined in the JSON file and all the DB records.
Eg: The JSON file that defines the keys for a module can look like this:
"key1": "value1" "key2": { "valid JSON": "here", "it": { "can": {"be": { "arbitrarily": "nested"}}} }
Modules are defined in JSON files under a config path defined in "chenile.config.path". For example module1 is defined in module1.json directly under "chenile.config.path".
These JSON values can be over-ridden in two ways in the database:

1. They can be over-ridden for all "requests" whether they have a custom attribute or not (__GLOBAL__)
2. They can be over-ridden for specific "requests" that have a custom attribute (eg. all requests that belong to a client "tenant0")

The whole JSON can be over-ridden or specific portions of the JSON (given by path) can be over-ridden. Please see the test cases for more details.
It is possible that no JSON file exists. All keys can be defined in the database directly without using the JSON. In that case, keys can only be defined using path as null. Subsequent records can override this record. It is assumed that DB records don't alter the same path. If they do so, the result is indeterminate.

allKeysForModule

private Map<String,Object> allKeysForModule(String module,
 String customAttribute)

Parameters:

module - name of the module

Returns:

all the keys in the module. This includes all the keys in the JSON file (if found) and also the DB keys.

customizationAttribute

protected String customizationAttribute()

Override this in a subclass to change the default behaviour.

Returns:

the value of custom attribute from request headers. Default implementation returns the value of the tenant ID header.