alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface Class Reference

Factory interface to component properties. More...

#include <PropertiesFactoryInterface.h>

Inheritance diagram for alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface:

Public Member Functions
virtual	~PropertiesFactoryInterface ()=default
virtual std::shared_ptr< PropertiesInterface >	getProperties (const std::string &uri) noexcept=0
	Create properties interface for a given component and namespace. More...

Detailed Description

Factory interface to component properties.

This interface provide a way to construct component-specific key-value storage. The storage is identified by configuration URI (Uniform Resource Identifier) to disambiguate properties between different components. The format of configuration URI is implementation specific, but must conform to RFC3986.

Application may operate with a single or multiple instances of this interface, that use different implementation, or provide access to different physical resources for access control.

See also

Properties Implementation

Constructor & Destructor Documentation

~PropertiesFactoryInterface()

virtual alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface::~PropertiesFactoryInterface ( )

virtualdefault

Destructor.

Member Function Documentation

getProperties()

virtual std::shared_ptr<PropertiesInterface> alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface::getProperties ( const std::string &  uri )

pure virtualnoexcept

Create properties interface for a given component and namespace.

This method creates interface to access component specific configuration. The implementation maps URI into implementation-specific configuration container, and URI can be treated as a file location, database or table name, or region in non-volatile memory.

The method may return the same or different instances for the same configuration URI, but if different instances are returned, all of them must provide access to the same configuration container.

Parameters

uri	Resource URI. The format must conform to RFC3986, but handling is implementation-specific.

Returns

Reference to properties adapter or nullptr on error.

Implemented in alexaClientSDK::propertiesInterfaces::test::StubPropertiesFactory.

---

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

• /workplace/avs-device-sdk/core/Properties/PropertiesInterfaces/include/acsdk/PropertiesInterfaces/PropertiesFactoryInterface.h