AuthorizationManager.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 ACSDKAUTHORIZATION_AUTHORIZATIONMANAGER_H_
#define ACSDKAUTHORIZATION_AUTHORIZATIONMANAGER_H_

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

#include <acsdkAuthorization/AuthorizationManagerStorage.h>
#include <acsdkAuthorizationInterfaces/AuthorizationAuthorityInterface.h>
#include <acsdkAuthorizationInterfaces/AuthorizationManagerInterface.h>
#include <AVSCommon/SDKInterfaces/AuthDelegateInterface.h>
#include <AVSCommon/SDKInterfaces/Storage/MiscStorageInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <RegistrationManager/CustomerDataHandler.h>
#include <RegistrationManager/CustomerDataManagerInterface.h>

namespace alexaClientSDK {
namespace acsdkAuthorization {

class AuthorizationManager
        : public acsdkAuthorizationInterfaces::AuthorizationManagerInterface
        , public acsdkAuthorizationInterfaces::AuthorizationAuthorityInterface
        , public avsCommon::utils::RequiresShutdown
        , public registrationManager::CustomerDataHandler
        , public std::enable_shared_from_this<AuthorizationManager> {
public:
    static std::shared_ptr<acsdkAuthorization::AuthorizationManager> create(
        const std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>& storage,
        const std::shared_ptr<registrationManager::CustomerDataManagerInterface>& customerDataManager);

    void reportStateChange(
        const avsCommon::sdkInterfaces::AuthObserverInterface::FullState& state,
        const std::string& authId,
        const std::string& userId) override;
    void add(const std::shared_ptr<acsdkAuthorizationInterfaces::AuthorizationAdapterInterface>& adapter) override;

    void logout() override;
    avsCommon::sdkInterfaces::AuthObserverInterface::State getState() override;
    std::string getActiveAuthorization() override;

    void addAuthObserver(std::shared_ptr<avsCommon::sdkInterfaces::AuthObserverInterface> observer) override;
    void removeAuthObserver(std::shared_ptr<avsCommon::sdkInterfaces::AuthObserverInterface> observer) override;
    std::string getAuthToken() override;
    void onAuthFailure(const std::string& token) override;

    void clearData() override;

    void setRegistrationManager(
        const std::shared_ptr<registrationManager::RegistrationManagerInterface> registrationManager);

    // @name RequiresShutdown Functions
    void doShutdown() override;

private:
    AuthorizationManager(
        const std::shared_ptr<AuthorizationManagerStorage>& storage,
        const std::shared_ptr<registrationManager::CustomerDataManagerInterface>& customerDataManager);

    bool init();

    void handleTransition(
        const avsCommon::sdkInterfaces::AuthObserverInterface::FullState& newState,
        const std::string& authId,
        const std::string& userId);

    void clearDataLocked();

    void logoutHelper(std::unique_lock<std::mutex>& lock);

    void setStateLocked(const avsCommon::sdkInterfaces::AuthObserverInterface::FullState& newState);

    void setActiveLocked(const std::string& adapterId, const std::string& userId);

    void persist(const std::string& adapterId, const std::string& userId);

    std::mutex m_mutex;

    std::mutex m_observersMutex;

    std::unordered_map<std::string, std::shared_ptr<acsdkAuthorizationInterfaces::AuthorizationAdapterInterface>>
        m_adapters;

    std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::AuthObserverInterface>> m_observers;

    std::shared_ptr<acsdkAuthorizationInterfaces::AuthorizationAdapterInterface> m_activeAdapter;

    std::string m_activeAdapterId;

    std::string m_activeUserId;

    avsCommon::sdkInterfaces::AuthObserverInterface::FullState m_authState;

    std::shared_ptr<AuthorizationManagerStorage> m_storage;

    std::shared_ptr<registrationManager::RegistrationManagerInterface> m_registrationManager;

    avsCommon::utils::threading::Executor m_executor;
};

}  // namespace acsdkAuthorization
}  // namespace alexaClientSDK

#endif  // ACSDKAUTHORIZATION_AUTHORIZATIONMANAGER_H_