AVSGatewayManager.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_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_AVSGATEWAYMANAGER_H_
#define ALEXA_CLIENT_SDK_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_AVSGATEWAYMANAGER_H_

#include <memory>
#include <mutex>
#include <string>
#include <unordered_set>

#include <acsdkPostConnectOperationProviderRegistrarInterfaces/PostConnectOperationProviderRegistrarInterface.h>
#include <AVSCommon/SDKInterfaces/AVSGatewayAssignerInterface.h>
#include <AVSCommon/SDKInterfaces/AVSGatewayManagerInterface.h>
#include <AVSCommon/SDKInterfaces/AuthDelegateInterface.h>
#include <AVSCommon/SDKInterfaces/PostConnectOperationProviderInterface.h>
#include <AVSGatewayManager/PostConnectVerifyGatewaySender.h>
#include <AVSCommon/Utils/Configuration/ConfigurationNode.h>
#include <AVSGatewayManager/Storage/AVSGatewayManagerStorageInterface.h>
#include <RegistrationManager/CustomerDataHandler.h>

namespace alexaClientSDK {
namespace avsGatewayManager {

class AVSGatewayManager
        : public avsCommon::sdkInterfaces::AVSGatewayManagerInterface
        , public avsCommon::sdkInterfaces::PostConnectOperationProviderInterface
        , public registrationManager::CustomerDataHandler {
public:
    static std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface> createAVSGatewayManagerInterface(
        std::unique_ptr<storage::AVSGatewayManagerStorageInterface> avsGatewayManagerStorage,
        const std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>& authDelegate,
        const std::shared_ptr<registrationManager::CustomerDataManagerInterface>& customerDataManager,
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationRoot,
        const std::shared_ptr<
            acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface>&
            providerRegistrar,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    static std::shared_ptr<AVSGatewayManager> create(
        std::shared_ptr<storage::AVSGatewayManagerStorageInterface> avsGatewayManagerStorage,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> customerDataManager,
        const avsCommon::utils::configuration::ConfigurationNode& configurationRoot,
        std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate = nullptr,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    bool setAVSGatewayAssigner(
        std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayAssignerInterface> avsGatewayAssigner) override;
    std::string getGatewayURL() const override;
    bool setGatewayURL(const std::string& avsGatewayURL) override;
    void addObserver(std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayObserverInterface> observer) override;
    void removeObserver(std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayObserverInterface> observer) override;

    std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationInterface> createPostConnectOperation() override;

    void clearData() override;

    void onGatewayVerified(
        const std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationInterface>& verifyGatewaySender);

    ~AVSGatewayManager();

private:
    AVSGatewayManager(
        std::shared_ptr<storage::AVSGatewayManagerStorageInterface> avsGatewayManagerStorage,
        std::shared_ptr<registrationManager::CustomerDataManagerInterface> customerDataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder,
        const std::string& defaultGateway);

    bool init();

    bool saveStateLocked();

    std::shared_ptr<storage::AVSGatewayManagerStorageInterface> m_avsGatewayStorage;

    std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayAssignerInterface> m_avsGatewayAssigner;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    mutable std::mutex m_mutex;

    std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationInterface> m_currentVerifyGatewaySender;

    const std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> m_authDelegate;

    GatewayVerifyState m_currentState;

    std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayObserverInterface>> m_observers;
};

}  // namespace avsGatewayManager
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSGATEWAYMANAGER_INCLUDE_AVSGATEWAYMANAGER_AVSGATEWAYMANAGER_H_