MiscStorageInterface.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_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STORAGE_MISCSTORAGEINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STORAGE_MISCSTORAGEINTERFACE_H_

#include <string>
#include <unordered_map>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace storage {

class MiscStorageInterface {
public:
    enum class KeyType {
        UNKNOWN_KEY,
        STRING_KEY
    };

    enum class ValueType {
        UNKNOWN_VALUE,
        STRING_VALUE
    };

    virtual ~MiscStorageInterface() = default;

    virtual bool createDatabase() = 0;

    virtual bool open() = 0;

    virtual bool isOpened() = 0;

    virtual void close() = 0;

    virtual bool createTable(
        const std::string& componentName,
        const std::string& tableName,
        KeyType keyType,
        ValueType valueType) = 0;

    virtual bool clearTable(const std::string& componentName, const std::string& tableName) = 0;

    virtual bool deleteTable(const std::string& componentName, const std::string& tableName) = 0;

    virtual bool get(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        std::string* value) = 0;

    virtual bool add(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) = 0;

    virtual bool update(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) = 0;

    virtual bool put(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        const std::string& value) = 0;

    virtual bool remove(const std::string& componentName, const std::string& tableName, const std::string& key) = 0;

    virtual bool tableEntryExists(
        const std::string& componentName,
        const std::string& tableName,
        const std::string& key,
        bool* tableEntryExistsValue) = 0;

    virtual bool tableExists(
        const std::string& componentName,
        const std::string& tableName,
        bool* tableExistsValue) = 0;

    virtual bool load(
        const std::string& componentName,
        const std::string& tableName,
        std::unordered_map<std::string, std::string>* valueContainer) = 0;
};

}  // namespace storage
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_STORAGE_MISCSTORAGEINTERFACE_H_