63 lines
2.4 KiB
C++
63 lines
2.4 KiB
C++
/*
|
|
* 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 REGISTRATIONMANAGER_CUSTOMERDATAHANDLER_H_
|
|
#define REGISTRATIONMANAGER_CUSTOMERDATAHANDLER_H_
|
|
|
|
#include <memory>
|
|
|
|
#include <RegistrationManager/CustomerDataHandlerInterface.h>
|
|
#include <RegistrationManager/CustomerDataManagerInterface.h>
|
|
|
|
namespace alexaClientSDK {
|
|
namespace registrationManager {
|
|
|
|
/**
|
|
* Abstract base class which requires the derived class to implement a @c clearData() function.
|
|
*
|
|
* For changes in the device registration, it is extremely important to remove any customer data saved in the device.
|
|
* Classes that have any data related to the currently logged user must extend this class to guarantee that their data
|
|
* will be wiped out during logout.
|
|
*/
|
|
class CustomerDataHandler : public registrationManager::CustomerDataHandlerInterface {
|
|
public:
|
|
/**
|
|
* Build and register the new object with the CustomerDataManager.
|
|
*
|
|
* @param dataManager The @c CustomerDataManager that will keep track of the new data handler.
|
|
* @note The customerDataManager must have a valid pointer to a manager instance.
|
|
*/
|
|
CustomerDataHandler(const std::shared_ptr<registrationManager::CustomerDataManagerInterface>& dataManager);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~CustomerDataHandler();
|
|
|
|
private:
|
|
/**
|
|
* Keep a constant pointer to CustomerDataManager so that the CustomerDataHandler object can auto remove itself.
|
|
*
|
|
* @note The goal is to guarantee that all customerDataHandlers are properly managed. The trade-off is that we have
|
|
* to keep a shared_pointer to its manager and the manager has to keep a raw pointer to each handler.
|
|
*/
|
|
const std::shared_ptr<registrationManager::CustomerDataManagerInterface> m_dataManager;
|
|
};
|
|
|
|
} // namespace registrationManager
|
|
} // namespace alexaClientSDK
|
|
|
|
#endif // REGISTRATIONMANAGER_CUSTOMERDATAHANDLER_H_
|