/*
 * Copyright (c) 2019, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_PROTOCOL_HANDLER_RPC_PROTECTION_MANAGER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_PROTOCOL_HANDLER_RPC_PROTECTION_MANAGER_H_

#include <cstdint>
#include <memory>

#include "application_manager/application.h"
#include "application_manager/policies/policy_handler_observer.h"
#include "smart_objects/smart_object.h"

namespace ns_smart_device_link {
namespace ns_smart_objects {
class SmartObject;
}  // namespace ns_smart_objects
}  // namespace ns_smart_device_link
namespace smart_objects = ns_smart_device_link::ns_smart_objects;

namespace application_manager {
class Application;
}  // namespace application_manager

namespace application_manager {
/**
 * @brief RPCProtectionManager interface
 * This entity exists to get info from policy table regarding encryption on
 * application and function group level, as well as make decisions whether
 * certain RPC should be encrypted or not.
 * It mediates communication between PRCService and
 * PolicyEncryptionFlagGetterInterface which is implemented by PolicyManager,
 * providing adequate level of abstraction.
 */
class RPCProtectionManager : public policy::PolicyHandlerObserver {
 public:
  /*
   * @brief virtual destructor RPCProtectionManager
   */
  virtual ~RPCProtectionManager() {}

  /*
   * @brief checks whether given rpc requires encryption by policy
   * @param function_id function id
   * @param app ref to Application
   * @param is_rpc_service_secure the flag the secure service started
   * @return true if function need encryption for current app,  else false
   */
  virtual bool CheckPolicyEncryptionFlag(
      const uint32_t function_id,
      const ApplicationSharedPtr app,
      const bool is_rpc_service_secure) const = 0;
  /*
   * @brief check whether given rpc is saved to internal cache and needs to be
   * encrypted before sending to mobile
   * @param app_id application id
   * @param correlation_id correlation id
   * @return true if the message with correlation id correlation_id needed e
   * ncryption else false
   */
  virtual bool IsInEncryptionNeededCache(
      const uint32_t app_id, const uint32_t conrrelation_id) const = 0;

  /*
   * @brief Adds app id and correlation id of a message to internal cache
   * @param app_id application if
   * @param correlation_id correlation id
   */
  virtual void AddToEncryptionNeededCache(const uint32_t app_id,
                                          const uint32_t correlation_id) = 0;

  /*
   * @brief Removes app id and correlation id of a message from internal cache
   * @param app_id application if
   * @param correlation_id correlation id
   */
  virtual void RemoveFromEncryptionNeededCache(
      const uint32_t app_id, const uint32_t correlation_id) = 0;
};
}  // namespace application_manager

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_PROTOCOL_HANDLER_RPC_PROTECTION_MANAGER_H_