SQLiteMiscStorage.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEMISCSTORAGE_H_
#define ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEMISCSTORAGE_H_

#include <mutex>

#include <AVSCommon/SDKInterfaces/Storage/MiscStorageInterface.h>
#include <AVSCommon/Utils/Configuration/ConfigurationNode.h>
#include <SQLiteStorage/SQLiteDatabase.h>

namespace alexaClientSDK {
namespace storage {
namespace sqliteStorage {

class SQLiteMiscStorage : public avsCommon::sdkInterfaces::storage::MiscStorageInterface {
public:
    static std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface> createMiscStorageInterface(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationRoot);

    static std::unique_ptr<SQLiteMiscStorage> create(
        const avsCommon::utils::configuration::ConfigurationNode& configurationRoot);

    static std::unique_ptr<SQLiteMiscStorage> create(const std::string& databasePath);

    ~SQLiteMiscStorage();

    bool createDatabase() override;
    bool open() override;
    bool isOpened() override;
    void close() override;
    bool createTable(
        const std::string& componentName,
        const std::string& tableName,
        KeyType keyType,
        ValueType valueType) override;
    bool clearTable(const std::string& componentName, const std::string& tableName) override;
    bool deleteTable(const std::string& componentName, const std::string& tableName) override;
    bool get(const std::string& componentName, const std::string& tableName, const std::string& key, std::string* value)
        override;
    bool add(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) override;
    bool update(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) override;
    bool put(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) override;
    bool remove(const std::string& componentName, const std::string& tableName, const std::string& key) override;
    bool tableEntryExists(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        bool* tableEntryExistsValue) override;
    bool tableExists(const std::string& componentName, const std::string& tableName, bool* tableExistsValue) override;
    bool load(
        const std::string& componentName,
        const std::string& tableName,
        std::unordered_map<std::string, std::string>* valueContainer) override;

    SQLiteDatabase& getDatabase();

private:
    SQLiteMiscStorage(const std::string& dbFilePath);

    bool getKeyValueTypesLocked(
        const std::string& componentName,
        const std::string& tableName,
        KeyType* keyType,
        ValueType* valueType);

    std::string checkKeyTypeLocked(const std::string& componentName, const std::string& tableName, KeyType keyType);

    std::string checkValueTypeLocked(
        const std::string& componentName,
        const std::string& tableName,
        ValueType valueType);

    std::string checkKeyValueTypeLocked(
        const std::string& componentName,
        const std::string& tableName,
        KeyType keyType,
        ValueType valueType);

    bool createDatabaseLocked();

    bool openLocked();

    bool isOpenedLocked();

    void closeLocked();

    bool createTableLocked(
        const std::string& componentName,
        const std::string& tableName,
        KeyType keyType,
        ValueType valueType);

    bool clearTableLocked(const std::string& componentName, const std::string& tableName);

    bool deleteTableLocked(const std::string& componentName, const std::string& tableName);

    bool getLocked(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        std::string* value);

    bool addLocked(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value);

    bool updateLocked(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value);

    bool putLocked(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value);

    bool removeLocked(const std::string& componentName, const std::string& tableName, const std::string& key);

    bool tableEntryExistsLocked(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        bool* tableEntryExistsValue);

    bool tableExistsLocked(const std::string& componentName, const std::string& tableName, bool* tableExistsValue);

    bool loadLocked(
        const std::string& componentName,
        const std::string& tableName,
        std::unordered_map<std::string, std::string>* valueContainer);

    alexaClientSDK::storage::sqliteStorage::SQLiteDatabase m_db;

    std::mutex m_mutex;
};

}  // namespace sqliteStorage
}  // namespace storage
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEMISCSTORAGE_H_