GenericInventory.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 ACSDKASSETMANAGERCLIENT_GENERICINVENTORY_H_
#define ACSDKASSETMANAGERCLIENT_GENERICINVENTORY_H_

#include <set>
#include <unordered_map>
#include <unordered_set>

#include "acsdkAssetManagerClient/ArtifactWrapper.h"
#include "acsdkAssetManagerClientInterfaces/ArtifactWrapperFactoryInterface.h"

namespace alexaClientSDK {
namespace acsdkAssets {
namespace client {

using Setting = std::set<std::string>;
using SettingsMap = std::unordered_map<std::string, Setting>;

class GenericInventory
        : public std::enable_shared_from_this<GenericInventory>
        , public clientInterfaces::ArtifactUpdateValidator {
public:
    ~GenericInventory() override;

    inline const char* getName() const {
        return m_name.data();
    }

    std::shared_ptr<clientInterfaces::ArtifactWrapperInterface> prepareForSettingChange(const SettingsMap& newSettings);

    bool commitChange();

    void cancelChange();

    std::string getArtifactPath();

    void setCurrentActivePriority(commonInterfaces::Priority priority);

    bool isSettingReady(const SettingsMap& setting);

protected:
    GenericInventory(
            std::string name,
            std::shared_ptr<clientInterfaces::ArtifactWrapperFactoryInterface> artifactWrapperFactory);

    virtual std::shared_ptr<commonInterfaces::ArtifactRequest> createRequest(const SettingsMap& settings) = 0;

    virtual bool applyChangesLocked(const std::string& path) = 0;

    void cancelChangeLocked();

    inline bool validateUpdate(
            const std::shared_ptr<commonInterfaces::ArtifactRequest>& request,
            const std::string& newPath) override {
        return m_activeArtifact != nullptr && m_activeArtifact->getRequest() == request && applyChangesLocked(newPath);
    }

private:
    const std::string m_name;
    const std::shared_ptr<clientInterfaces::ArtifactWrapperFactoryInterface> m_artifactWrapperFactory;

    std::shared_ptr<clientInterfaces::ArtifactWrapperInterface> m_activeArtifact;
    std::shared_ptr<clientInterfaces::ArtifactWrapperInterface> m_pendingArtifact;

    std::mutex m_eventMutex;
};

}  // namespace client
}  // namespace acsdkAssets
}  // namespace alexaClientSDK

#endif  // ACSDKASSETMANAGERCLIENT_GENERICINVENTORY_H_