Package org.opennms.netmgt.dao.mock

Class ConfigurationManagerServiceMock

java.lang.Object

org.opennms.netmgt.dao.mock.ConfigurationManagerServiceMock

All Implemented Interfaces:

ConfigurationManagerService

@Component
public class ConfigurationManagerServiceMock
extends Object
implements ConfigurationManagerService

It is a minimal mock for CM use. If configFile is passed, it will read and return as configEntity. Otherwise, it will return a new instance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_EXTENSION
static String	XML_EXTENSION

Fields inherited from interface org.opennms.features.config.service.api.ConfigurationManagerService

BASE_PATH

Constructor Summary

Constructors

Constructor	Description
ConfigurationManagerServiceMock()

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)	It will return config in following order.
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.
void	registerEventHandler(EventType type, ConfigUpdateInfo info, java.util.function.Consumer<ConfigUpdateInfo> consumer)
void	setConfigFileMap(Map<String,String> configFileMap)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.features.config.service.api.ConfigurationManagerService

getJSONStrConfiguration, registerConfiguration, registerEventHandler

Field Detail

JSON_EXTENSION

public static final String JSON_EXTENSION

See Also:

Constant Field Values

XML_EXTENSION

public static final String XML_EXTENSION

See Also:

Constant Field Values

Constructor Detail

ConfigurationManagerServiceMock

public ConfigurationManagerServiceMock()

Method Detail

setConfigFileMap

public void setConfigFileMap(Map<String,String> configFileMap)

registerConfigDefinition

public void registerConfigDefinition(String configName,
                                     ConfigDefinition configDefinition)

Description copied from interface: ConfigurationManagerService

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

Specified by:

registerConfigDefinition in interface ConfigurationManagerService

changeConfigDefinition

public void changeConfigDefinition(String configName,
                                   ConfigDefinition configDefinition)

Description copied from interface: ConfigurationManagerService

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

Specified by:

changeConfigDefinition in interface ConfigurationManagerService

getAllConfigDefinitions

public Map<String,ConfigDefinition> getAllConfigDefinitions()

Specified by:

getAllConfigDefinitions in interface ConfigurationManagerService

getRegisteredConfigDefinition

public Optional<ConfigDefinition> getRegisteredConfigDefinition(String configName)

Specified by:

getRegisteredConfigDefinition in interface ConfigurationManagerService

registerEventHandler

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

Specified by:

registerEventHandler in interface ConfigurationManagerService

registerConfiguration

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

Description copied from interface: ConfigurationManagerService

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

Specified by:

registerConfiguration in interface ConfigurationManagerService

configObject - (config object / JSONObject)

unregisterConfiguration

public void unregisterConfiguration(String configName,
                                    String configId)

Description copied from interface: ConfigurationManagerService

remove configure from service

Specified by:

unregisterConfiguration in interface ConfigurationManagerService

updateConfiguration

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

Description copied from interface: ConfigurationManagerService

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

Specified by:

updateConfiguration in interface ConfigurationManagerService

getJSONConfiguration

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

Description copied from interface: ConfigurationManagerService

get config as json by configName, configId

Specified by:

getJSONConfiguration in interface ConfigurationManagerService

Returns:

JSONObject

getJSONStrConfiguration

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

It will return config in following order. After first read, it will cache it in memory. updateConfig will overwrite existing config in memory

• memory
• json file
• xml file

Specified by:

getJSONStrConfiguration in interface ConfigurationManagerService

Parameters:

configName -

configId -

Returns:

See Also:

ConfigurationManagerService.getJSONStrConfiguration(String, String)

getConfigData

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

Description copied from interface: ConfigurationManagerService

get whole ConfigData by configName

Specified by:

getConfigData in interface ConfigurationManagerService

Returns:

ConfigData

getConfigNames

public Set<String> getConfigNames()

Description copied from interface: ConfigurationManagerService

get a list of registered configName

Specified by:

getConfigNames in interface ConfigurationManagerService

Returns:

configName set

unregisterSchema

public void unregisterSchema(String configName)

Description copied from interface: ConfigurationManagerService

it will remove both config and schema

Specified by:

unregisterSchema in interface ConfigurationManagerService

getConfigIds

public Set<String> getConfigIds(String configName)

Description copied from interface: ConfigurationManagerService

return configIds by configName

Specified by:

getConfigIds in interface ConfigurationManagerService