protection_common_settings.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
/**
 * @brief Defines ProtectionCommonSettings interface
 * 
 * @file protection_common_settings.h
 */
 
#ifndef API_MIP_PROTECTION_COMMON_SETTINGS_H_
#define API_MIP_PROTECTION_COMMON_SETTINGS_H_
 
#include <string>
#include <vector>
 
#include "mip/mip_namespace.h"
 
MIP_NAMESPACE_BEGIN
 
/**
 * @brief Settings to use for protection operations
 */
class ProtectionCommonSettings {
public:
  ProtectionCommonSettings(std::string applicationScenarioId = std::string())
      : mApplicationScenarioId(applicationScenarioId),
        mIsOfflineOnly(false) {}
 
  /**
   * @brief Gets the scenario Id provided by the application which is used to correlation with the server.
   *
   * @return Application scenario Id
   */
  std::string GetApplicationScenarioId() const {
    return mApplicationScenarioId;
  }
 
  /**
   * @brief Sets the scenario Id provided by the application
   * 
   * @param The application scenario Id
   */
  void SetApplicationScenarioId(std::string applicationScenarioId) { mApplicationScenarioId = applicationScenarioId; }
 
  /**
   * @brief Gets whether or not ProtectionEngine operation allows for online HTTP operations
   * 
   * @return True if HTTP operations are disallowed, else false
   * 
   * @note If this returns true, operation will only succeed if necessary content has already been cached.
   *       A mip::NetworkError will be thrown if needed info is not found.
   *       Consumption - content has already been previously decrypted and its unexpired license is cached.
   *       Protection  - unexpired templates have been cached and user cert is loaded
   *       Others - undefined
   */
  bool GetIsOfflineOnly() const { return mIsOfflineOnly; }
 
  /**
   * @brief Sets whether or not ProtectionEngine operation allows for online HTTP operations
   * 
   * @param isOfflineOnly True if HTTP operations are disallowed, else false
   * 
   * @note If this is set to true, operation will only succeed if necessary content has already been cached.
   *       A mip::NetworkError will be thrown if needed info is not found.
   *       Consumption - content has already been previously decrypted and its unexpired license is cached.
   *       Protection  - unexpired templates have been cached and user cert is loaded
   *       Others - undefined
   */
  virtual void SetIsOfflineOnly(bool isOfflineOnly) { mIsOfflineOnly = isOfflineOnly; }
 
  /**
   * @brief Set the custom settings, used for feature gating and testing.
   * 
   * @param customSettings List of name/value pairs.
   */
  void SetCustomSettings(const std::vector<std::pair<std::string, std::string>>& customSettings) {
    mCustomSettings = customSettings;
  }
    
  /**
   * @brief Get the custom settings, used for feature gating and testing.
   * 
   * @return List of name/value pairs.
   */
  const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const {
    return mCustomSettings;
  }
 
  /** @cond DOXYGEN_HIDE */
  virtual ~ProtectionCommonSettings() {}
  ProtectionCommonSettings& operator=(const ProtectionCommonSettings& other) {
    mApplicationScenarioId = other.mApplicationScenarioId;
    mIsOfflineOnly = other.mIsOfflineOnly;
    return *this;
  }
 
private:
  std::string mApplicationScenarioId;
  bool mIsOfflineOnly;
  std::vector<std::pair<std::string, std::string>> mCustomSettings;
 
  /** @endcond */
};
 
MIP_NAMESPACE_END
 
#endif // API_MIP_PROTECTION_Common_SETTINGS_H_