AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::acsdkProperties::EncryptedPropertiesFactory Class Reference

#include <EncryptedPropertiesFactory.h>

Inheritance diagram for alexaClientSDK::acsdkProperties::EncryptedPropertiesFactory:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkProperties::EncryptedPropertiesFactory:
Collaboration graph
[legend]

Public Member Functions

PropertiesFactoryInterface methods
std::shared_ptr< alexaClientSDK::acsdkPropertiesInterfaces::PropertiesInterfacegetProperties (const std::string &configUri) noexcept override
 Create properties interface for a given component and namespace. More...
 
- Public Member Functions inherited from alexaClientSDK::acsdkPropertiesInterfaces::PropertiesFactoryInterface
virtual ~PropertiesFactoryInterface ()=default
 

Static Public Member Functions

static std::shared_ptr< PropertiesFactoryInterfacecreate (const std::shared_ptr< alexaClientSDK::acsdkPropertiesInterfaces::PropertiesFactoryInterface > &innerFactory, const std::shared_ptr< alexaClientSDK::acsdkCryptoInterfaces::CryptoFactoryInterface > &cryptoFactory, const std::shared_ptr< alexaClientSDK::acsdkCryptoInterfaces::KeyStoreInterface > &keyStore) noexcept
 Creates properties factory using given dependencies. More...
 

Member Function Documentation

◆ create()

std::shared_ptr< PropertiesFactoryInterface > alexaClientSDK::acsdkProperties::EncryptedPropertiesFactory::create ( const std::shared_ptr< alexaClientSDK::acsdkPropertiesInterfaces::PropertiesFactoryInterface > &  innerFactory,
const std::shared_ptr< alexaClientSDK::acsdkCryptoInterfaces::CryptoFactoryInterface > &  cryptoFactory,
const std::shared_ptr< alexaClientSDK::acsdkCryptoInterfaces::KeyStoreInterface > &  keyStore 
)
staticnoexcept

Creates properties factory using given dependencies.

Parameters
[in]innerFactoryInternal factory for accessing properties in plain text manner.
[in]cryptoFactoryEncryption facilities factory.
[in]keyStoreHSM key store.
Returns
Reference to factory or nullptr on error.

◆ getProperties()

std::shared_ptr< PropertiesInterface > alexaClientSDK::acsdkProperties::EncryptedPropertiesFactory::getProperties ( const std::string &  uri)
overridevirtualnoexcept

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
uriResource URI. The format must conform to RFC3986, but handling is implementation-specific.
Returns
Reference to properties adapter or nullptr on error.

Implements alexaClientSDK::acsdkPropertiesInterfaces::PropertiesFactoryInterface.


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

AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0