io.stargate.config.store.api

Interface ConfigStore

public interface ConfigStore

Method Summary

Modifier and Type	Method and Description
ConfigWithOverrides	getConfigForModule(String moduleName) It retrieves the generic Map<String, Object> for a given module name.
default ConfigWithOverrides	getGlobalConfig() This is a convenience method that calls the this#getConfigForModule(String) with a stargate module name.

Method Detail

getConfigForModule

ConfigWithOverrides getConfigForModule(String moduleName)
                                throws MissingModuleSettingsException

It retrieves the generic Map<String, Object> for a given module name. The map is wrapped in the ConfigWithOverrides to allow the caller to get the setting value overridable by system property or environment variable.

If the caller will try to look up the config for a module that does not have any setting, it will throw the MissingModuleSettingsException. This is a RuntimeException and it's the caller's responsibility to catch it and handle gracefully or propagate upper in the call stack.

Throws:

MissingModuleSettingsException

getGlobalConfig

default ConfigWithOverrides getGlobalConfig()

This is a convenience method that calls the this#getConfigForModule(String) with a stargate module name.