Package org.opennms.features.config.service.api

Interface ConfigurationManagerService

All Known Implementing Classes:

ConfigurationManagerServiceImpl, ConfigurationManagerServiceMock

public interface ConfigurationManagerService

Responsible for managing Schemas and Configurations. A Schema is a set of rules that constrain the data of a Configuration. A Configuration is the data that defines the runtime behaviour of a service together with the code of that service.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method	Description
void	changeConfigDefinition(String configName, ConfigDefinition configDefinition)	Changes a ConfigDefinition.
Map<String,ConfigDefinition>	getAllConfigDefinitions()
Optional<ConfigData<org.json.JSONObject>>	getConfigData(String configName)	get whole ConfigData by configName
Set<String>	getConfigIds(String configName)	return configIds by configName
Set<String>	getConfigNames()	get a list of registered configName
Optional<org.json.JSONObject>	getJSONConfiguration(String configName, String configId)	get config as json by configName, configId
Optional<String>	getJSONStrConfiguration(String configName, String configId)	Use for osgi API
default Optional<String>	getJSONStrConfiguration(ConfigUpdateInfo configIdentifier)
Optional<ConfigDefinition>	getRegisteredConfigDefinition(String configName)
void	registerConfigDefinition(String configName, ConfigDefinition configDefinition)	Registers a ConfigDefinition under a unique configName.
void	registerConfiguration(String configName, String configId, JsonAsString configObject)	register a new configuration by config object.
default void	registerConfiguration(ConfigUpdateInfo configIdentifier, JsonAsString configObject)
default void	registerEventHandler(ConfigUpdateInfo info, java.util.function.Consumer<ConfigUpdateInfo> consumer)	Deprecated.
void	registerEventHandler(EventType type, ConfigUpdateInfo info, java.util.function.Consumer<ConfigUpdateInfo> consumer)
void	unregisterConfiguration(String configName, String configId)	remove configure from service
void	unregisterSchema(String configName)	it will remove both config and schema
void	updateConfiguration(String configName, String configId, JsonAsString configObject, boolean isReplace)	update config to a registered service name.

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

registerConfigDefinition

void registerConfigDefinition(String configName,
                              ConfigDefinition configDefinition)

Registers a ConfigDefinition under a unique configName. If the schema id is present it will throw an IllegalArgumentException.

changeConfigDefinition

void changeConfigDefinition(String configName,
                            ConfigDefinition configDefinition)

Changes a ConfigDefinition. If the configName is not present it will throw an IllegalArgumentException.

getAllConfigDefinitions

Map<String,ConfigDefinition> getAllConfigDefinitions()

getRegisteredConfigDefinition

Optional<ConfigDefinition> getRegisteredConfigDefinition(String configName)

registerEventHandler

@Deprecated
default void registerEventHandler(ConfigUpdateInfo info,
                                  java.util.function.Consumer<ConfigUpdateInfo> consumer)

Deprecated.

registerEventHandler

void registerEventHandler(EventType type,
                          ConfigUpdateInfo info,
                          java.util.function.Consumer<ConfigUpdateInfo> consumer)

registerConfiguration

void registerConfiguration(String configName,
                           String configId,
                           JsonAsString configObject)

register a new configuration by config object. It will make sure the configId is not duplicated !!!

Parameters:

configName -

configId -

configObject - (config object / JSONObject)

registerConfiguration

default void registerConfiguration(ConfigUpdateInfo configIdentifier,
                                   JsonAsString configObject)

unregisterConfiguration

void unregisterConfiguration(String configName,
                             String configId)

remove configure from service

Parameters:

configId -

updateConfiguration

void updateConfiguration(String configName,
                         String configId,
                         JsonAsString configObject,
                         boolean isReplace)

update config to a registered service name. It can be partial data and copy into existing config. The flow of update 1. reading the config by configName & configId 2. if replace is true, the whole new config will be replaced directly if replace is false, the new config will copy to existing database config by its property keys to config in database 3. validate 4. update db

Parameters:

configName -

configId -

configObject -

isReplace -

Throws:

ValidationException

getJSONConfiguration

Optional<org.json.JSONObject> getJSONConfiguration(String configName,
                                                   String configId)

get config as json by configName, configId

Parameters:

configName -

configId -

Returns:

JSONObject

getJSONStrConfiguration

Optional<String> getJSONStrConfiguration(String configName,
                                         String configId)

Use for osgi API

Returns:

config in json string

See Also:

getJSONStrConfiguration(String, String)

getJSONStrConfiguration

default Optional<String> getJSONStrConfiguration(ConfigUpdateInfo configIdentifier)

getConfigData

Optional<ConfigData<org.json.JSONObject>> getConfigData(String configName)

get whole ConfigData by configName

Parameters:

configName -

Returns:

ConfigData

getConfigNames

Set<String> getConfigNames()

get a list of registered configName

Returns:

configName set

unregisterSchema

void unregisterSchema(String configName)

it will remove both config and schema

Parameters:

configName -

getConfigIds

Set<String> getConfigIds(String configName)

return configIds by configName

Parameters:

configName -