senzing::sdk::SzConfigManager Class Reference

Manages persisted Senzing configurations and the default config registry. More...

#include <SzConfigManager.hpp>

Inheritance diagram for senzing::sdk::SzConfigManager:

Public Member Functions
virtual	~SzConfigManager ()=default
virtual std::unique_ptr< SzConfig >	CreateConfig ()=0
	Creates a new in-memory config from the registered template.
virtual std::unique_ptr< SzConfig >	CreateConfig (const std::string &configDefinition)=0
	Creates an in-memory config from the supplied JSON definition.
virtual std::unique_ptr< SzConfig >	CreateConfig (int64_t configID)=0
	Loads the persisted config with the given ID into a new in-memory config.
virtual int64_t	RegisterConfig (const std::string &configDefinition, const std::string &configComment)=0
	Registers a config definition with a comment; returns the new config ID.
virtual int64_t	RegisterConfig (const std::string &configDefinition)=0
	Registers a config definition (auto-generated comment); returns the ID.
virtual std::string	GetConfigRegistry ()=0
	Returns JSON describing all registered configurations.
virtual int64_t	GetDefaultConfigID ()=0
	Returns the current default configuration ID.
virtual void	ReplaceDefaultConfigID (int64_t currentDefaultConfigID, int64_t newDefaultConfigID)=0
	Atomically replaces the default config ID if it currently matches currentDefaultConfigID.
virtual void	SetDefaultConfigID (int64_t configID)=0
	Sets the default configuration ID.
virtual int64_t	SetDefaultConfig (const std::string &configDefinition, const std::string &configComment)=0
	Registers configDefinition (with comment) and sets it as default; returns the new config ID.
virtual int64_t	SetDefaultConfig (const std::string &configDefinition)=0
	Registers configDefinition (auto comment) and sets it as default.

Detailed Description

Manages persisted Senzing configurations and the default config registry.

CreateConfig returns a std::unique_ptr<SzConfig> – the caller owns the in-memory config handle and its native resources are released when the pointer is destroyed (mirrors the C#-returned managed SzConfig object).

Constructor & Destructor Documentation

~SzConfigManager()

virtual senzing::sdk::SzConfigManager::~SzConfigManager ( )

virtualdefault

Member Function Documentation

CreateConfig() [1/3]

virtual std::unique_ptr< SzConfig > senzing::sdk::SzConfigManager::CreateConfig ( )

pure virtual

Creates a new in-memory config from the registered template.

Implemented in senzing::sdk::core::SzCoreConfigManager.

CreateConfig() [2/3]

virtual std::unique_ptr< SzConfig > senzing::sdk::SzConfigManager::CreateConfig ( const std::string &  configDefinition )

pure virtual

Creates an in-memory config from the supplied JSON definition.

Implemented in senzing::sdk::core::SzCoreConfigManager.

CreateConfig() [3/3]

virtual std::unique_ptr< SzConfig > senzing::sdk::SzConfigManager::CreateConfig ( int64_t  configID )

pure virtual

Loads the persisted config with the given ID into a new in-memory config.

Implemented in senzing::sdk::core::SzCoreConfigManager.

GetConfigRegistry()

virtual std::string senzing::sdk::SzConfigManager::GetConfigRegistry ( )

pure virtual

Returns JSON describing all registered configurations.

Implemented in senzing::sdk::core::SzCoreConfigManager.

GetDefaultConfigID()

virtual int64_t senzing::sdk::SzConfigManager::GetDefaultConfigID ( )

pure virtual

Returns the current default configuration ID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

RegisterConfig() [1/2]

virtual int64_t senzing::sdk::SzConfigManager::RegisterConfig ( const std::string &  configDefinition )

pure virtual

Registers a config definition (auto-generated comment); returns the ID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

RegisterConfig() [2/2]

virtual int64_t senzing::sdk::SzConfigManager::RegisterConfig ( const std::string &  configDefinition, const std::string &  configComment  )

pure virtual

Registers a config definition with a comment; returns the new config ID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

ReplaceDefaultConfigID()

virtual void senzing::sdk::SzConfigManager::ReplaceDefaultConfigID ( int64_t  currentDefaultConfigID, int64_t  newDefaultConfigID  )

pure virtual

Atomically replaces the default config ID if it currently matches currentDefaultConfigID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

SetDefaultConfig() [1/2]

virtual int64_t senzing::sdk::SzConfigManager::SetDefaultConfig ( const std::string &  configDefinition )

pure virtual

Registers configDefinition (auto comment) and sets it as default.

Implemented in senzing::sdk::core::SzCoreConfigManager.

SetDefaultConfig() [2/2]

virtual int64_t senzing::sdk::SzConfigManager::SetDefaultConfig ( const std::string &  configDefinition, const std::string &  configComment  )

pure virtual

Registers configDefinition (with comment) and sets it as default; returns the new config ID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

SetDefaultConfigID()

virtual void senzing::sdk::SzConfigManager::SetDefaultConfigID ( int64_t  configID )

pure virtual

Sets the default configuration ID.

Implemented in senzing::sdk::core::SzCoreConfigManager.

---

The documentation for this class was generated from the following file:

• senzing/sdk/SzConfigManager.hpp