protection_profile.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.
 *
 */
#ifndef API_MIP_PROTECTION_PROTECTION_PROFILE_H_
#define API_MIP_PROTECTION_PROTECTION_PROFILE_H_
 
#include <memory>
#include <string>
 
#include "mip/common_types.h"
#include "mip/dns_redirection.h"
#include "mip/error.h"
#include "mip/http_delegate.h"
#include "mip/logger_delegate.h"
#include "mip/mip_context.h"
#include "mip/mip_export.h"
#include "mip/mip_namespace.h"
#include "mip/protection/protection_common_types.h"
#include "mip/protection/protection_engine.h"
#include "mip/task_dispatcher_delegate.h"
#include "mip/xml_delegate.h"
 
MIP_NAMESPACE_BEGIN
 
class ProtectionProfile {
public:
  class Observer {
  public:
    virtual ~Observer() { }
    virtual void OnLoadSuccess(
        const std::shared_ptr<ProtectionProfile>& profile,
        const std::shared_ptr<void>& context) { UNUSED(profile); UNUSED(context); }
 
    virtual void OnLoadFailure(
        const std::exception_ptr& error,
        const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnListEnginesSuccess(
        const std::vector<std::string>& engineIds,
        const std::shared_ptr<void>& context) { UNUSED(engineIds); UNUSED(context); }
 
    virtual void OnListEnginesFailure(
        const std::exception_ptr& error,
        const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnAddEngineSuccess(
        const std::shared_ptr<ProtectionEngine>& engine,
        const std::shared_ptr<void>& context) { UNUSED(engine); UNUSED(context); }
 
    virtual void OnAddEngineFailure(
        const std::exception_ptr& error,
        const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnDeleteEngineSuccess(
        const std::shared_ptr<void>& context) { UNUSED(context); }
 
    virtual void OnDeleteEngineFailure(
        const std::exception_ptr& error,
        const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
  protected:
    Observer() { }
  };
 
  class Settings {
  public:
    Settings(
        const std::shared_ptr<MipContext>& mipContext,
        CacheStorageType cacheStorageType,
        const std::shared_ptr<ConsentDelegate>& consentDelegate,
        const std::shared_ptr<ProtectionProfile::Observer>& observer)
        : mMipContext(mipContext),
          mCacheStorageType(cacheStorageType),
          mConsentDelegate(consentDelegate),
          mObserver(observer),
          mCanCacheLicenses(true),
#if defined(MIP_OFFLINE_PUBLISHING_ENABLED) || defined(SWIG) || defined(SWIG_DIRECTORS)
          mOfflinePublishing(false),
#endif // MIP_OFFLINE_PUBLISHING_ENABLED
          mDnsRedirection(DnsRedirection::MDEDiscovery) {
    }
 
    Settings(
        const std::shared_ptr<MipContext>& mipContext,
        CacheStorageType cacheStorageType,
        const std::shared_ptr<ConsentDelegate>& consentDelegate)
        : Settings(mipContext, cacheStorageType, consentDelegate, nullptr /*observer*/) {
    }
 
    ~Settings() { }
    CacheStorageType GetCacheStorageType() const { return mCacheStorageType; }
 
    std::shared_ptr<ConsentDelegate> GetConsentDelegate() const { return mConsentDelegate; }
 
    std::shared_ptr<ProtectionProfile::Observer> GetObserver() const { return mObserver; }
 
    std::shared_ptr<MipContext> GetMipContext() const { return mMipContext; }
 
    std::shared_ptr<HttpDelegate> GetHttpDelegate() const { return mHttpDelegate; }
 
    void SetHttpDelegate(const std::shared_ptr<HttpDelegate>& httpDelegate) { mHttpDelegate = httpDelegate; }
 
    std::shared_ptr<StorageDelegate> GetStorageDelegate() const { return mStorageDelegate; }
 
    void SetStorageDelegate(const std::shared_ptr<StorageDelegate>& storageDelegate) { mStorageDelegate = storageDelegate; }
 
    std::shared_ptr<TaskDispatcherDelegate> GetTaskDispatcherDelegate() const { return mTaskDispatcherDelegate; }
 
    void SetTaskDispatcherDelegate(const std::shared_ptr<TaskDispatcherDelegate>& taskDispatcherDelegate) {
      mTaskDispatcherDelegate = taskDispatcherDelegate;
    }
 
    void SetSessionId(const std::string& sessionId) { mSessionId = sessionId; }
 
    const std::string& GetSessionId() const { return mSessionId; }
 
    void SetCanCacheLicenses(bool canCacheLicenses) {
      mCanCacheLicenses = canCacheLicenses;
    }
 
    bool CanCacheLicenses() const {
      return mCanCacheLicenses;
    }
 
    void SetCustomSettings(const std::vector<std::pair<std::string, std::string>>& customSettings) {
      mCustomSettings = customSettings;
    }
    
    const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const {
      return mCustomSettings;
    }
 
#if !defined(SWIG) && !defined(SWIG_DIRECTORS)
    const std::shared_ptr<void>& GetLoggerContext() const { return mLoggerContext; }
#endif
 
    void SetLoggerContext(const std::shared_ptr<void>& loggerContext) {
      mLoggerContext = loggerContext;
    }
    
    void AddRedirectionUri(const std::string& originalUri, const std::string& redirectUri) {
      mRedirectionUris[originalUri] = redirectUri;
    }
 
    const std::map<std::string, std::string>& GetRedirectionUris() const {
      return mRedirectionUris;
    }
#if defined(MIP_OFFLINE_PUBLISHING_ENABLED) || defined(SWIG) || defined(SWIG_DIRECTORS)
    bool GetOfflinePublishing() const {
      return mOfflinePublishing;
    }
 
    void SetOfflinePublishing(bool offlinePublishing) {
      mOfflinePublishing = offlinePublishing;
    }
#endif // MIP_OFFLINE_PUBLISHING_ENABLED
 
    DnsRedirection GetDnsRedirection() const {
      return mDnsRedirection;
    }
 
    void SetDnsRedirection(DnsRedirection dnsRedirection) {
      mDnsRedirection = dnsRedirection;
    }
 
  private:
    std::shared_ptr<MipContext> mMipContext;
    CacheStorageType mCacheStorageType;
    std::shared_ptr<ConsentDelegate> mConsentDelegate;
    std::shared_ptr<ProtectionProfile::Observer> mObserver;
    std::shared_ptr<HttpDelegate> mHttpDelegate;
    std::shared_ptr<TaskDispatcherDelegate> mTaskDispatcherDelegate;
    std::string mSessionId;
    bool mCanCacheLicenses = true;
    std::vector<std::pair<std::string, std::string>> mCustomSettings;
    std::shared_ptr<void> mLoggerContext;
    std::map<std::string, std::string> mRedirectionUris;
    std::shared_ptr<StorageDelegate> mStorageDelegate;
#if defined(MIP_OFFLINE_PUBLISHING_ENABLED) || defined(SWIG) || defined(SWIG_DIRECTORS)
    bool mOfflinePublishing;
#endif // MIP_OFFLINE_PUBLISHING_ENABLED
    DnsRedirection mDnsRedirection;
  };
 
  MIP_API static std::shared_ptr<AsyncControl> __CDECL LoadAsync(
      const Settings& settings,
      const std::shared_ptr<void>& context);
 
  MIP_API static std::shared_ptr<ProtectionProfile> __CDECL Load(const Settings& settings);
 
  MIP_API static const char* __CDECL GetVersion();
 
  virtual const Settings& GetSettings() const = 0;
 
  virtual std::shared_ptr<AsyncControl> ListEnginesAsync(const std::shared_ptr<void>& context) = 0;
 
  virtual std::vector<std::string> ListEngines() = 0;
 
  virtual std::shared_ptr<AsyncControl> AddEngineAsync(
      const ProtectionEngine::Settings& settings,
      const std::shared_ptr<void>& context) = 0;
 
  virtual std::shared_ptr<ProtectionEngine> AddEngine(const ProtectionEngine::Settings& settings) = 0;
 
  virtual std::shared_ptr<AsyncControl> DeleteEngineAsync(
      const std::string& engineId,
      const std::shared_ptr<void>& context) = 0;
 
  virtual void DeleteEngine(const std::string& engineId) = 0;
 
#ifndef MIP_CORE_PACKAGE
#if !defined(SWIG) && !defined(SWIG_DIRECTORS)
  [[deprecated("ProtectionProfile::GetPublishingLicenseInfo(const std::vector<uint8_t>&) is deprecated, use ProtectionProfile::GetPublishingLicenseInfo(const std::vector<uint8_t>&, const std::shared_ptr<MipContext>&)")]]
#endif
  MIP_API static std::shared_ptr<PublishingLicenseInfo> __CDECL GetPublishingLicenseInfo(
      const std::vector<uint8_t>& serializedPublishingLicense);
#endif // !MIP_CORE_PACKAGE
 
  MIP_API static std::shared_ptr<PublishingLicenseInfo> __CDECL GetPublishingLicenseInfo(
      const std::vector<uint8_t>& serializedPublishingLicense,
      const std::shared_ptr<MipContext>& mipContext);
 
  virtual ~ProtectionProfile() { }
  };
 
MIP_NAMESPACE_END
 
#endif // API_MIP_PROTECTION_PROTECTION_PROFILE_H_