file_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_FILE_FILE_PROFILE_H_
#define API_MIP_FILE_FILE_PROFILE_H_
 
#include <memory>
#include <string>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/dns_redirection.h"
#include "mip/error.h"
#include "mip/file/file_engine.h"
#include "mip/file/file_export.h"
#include "mip/http_delegate.h"
#include "mip/logger_delegate.h"
#include "mip/mip_context.h"
#include "mip/mip_namespace.h"
#include "mip/task_dispatcher_delegate.h"
 
MIP_NAMESPACE_BEGIN
 
class FileProfile {
public:
 
  class Observer {
  public:
    virtual ~Observer() {}
 
    virtual void OnLoadSuccess(
        const std::shared_ptr<mip::FileProfile>& 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 OnUnloadEngineSuccess(const std::shared_ptr<void>& context) { UNUSED(context); }
 
    virtual void OnUnloadEngineFailure(
        const std::exception_ptr& error, 
        const std::shared_ptr<void>& context) { UNUSED(error); UNUSED(context); }
 
    virtual void OnAddEngineSuccess(
        const std::shared_ptr<mip::FileEngine>& 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); }
 
    virtual void OnPolicyChanged(const std::string& engineId) { UNUSED(engineId); }
 
    virtual void OnAddPolicyEngineStarting(bool requiresPolicyFetch) { UNUSED(requiresPolicyFetch); }
 
  protected:
    Observer() {}
  };
 
  class Settings {
  public:
    Settings(
        const std::shared_ptr<MipContext>& mipContext,
        CacheStorageType cacheStorageType,
        std::shared_ptr<ConsentDelegate> consentDelegate,
        std::shared_ptr<Observer> observer)
        : mMipContext(mipContext),
          mCacheStorageType(cacheStorageType),
          mConsentDelegate(consentDelegate),
          mObserver(observer),
          mCanCacheLicenses(true),
          mDnsRedirection(DnsRedirection::MDEDiscovery) {}
 
    ~Settings() {}
    CacheStorageType GetCacheStorageType() const { return mCacheStorageType; }
 
    std::shared_ptr<ConsentDelegate> GetConsentDelegate() const { return mConsentDelegate; }
 
    std::shared_ptr<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<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;
    }
 
#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;
    }
 
    DnsRedirection GetDnsRedirection() const {
      return mDnsRedirection;
    }
 
    void SetDnsRedirection(DnsRedirection dnsRedirection) {
      mDnsRedirection = dnsRedirection;
    }
 
  private:
    std::shared_ptr<MipContext> mMipContext;
    std::string mPath;
    CacheStorageType mCacheStorageType;
    std::shared_ptr<ConsentDelegate> mConsentDelegate;
    std::shared_ptr<Observer> mObserver;
    std::string mSessionId;
    std::shared_ptr<HttpDelegate> mHttpDelegate;
    std::shared_ptr<TaskDispatcherDelegate> mTaskDispatcherDelegate;
    bool mCanCacheLicenses;
    std::shared_ptr<void> mLoggerContext;
    DnsRedirection mDnsRedirection;
  };
 
  FILE_API static std::shared_ptr<AsyncControl> __CDECL LoadAsync(
      const Settings& settings,
      const std::shared_ptr<void>& context);
 
  FILE_API static const char* __CDECL GetVersion();
 
  virtual ~FileProfile() {}
  virtual const Settings& GetSettings() const = 0;
 
  virtual std::shared_ptr<AsyncControl> ListEnginesAsync(const std::shared_ptr<void>& context) = 0;
 
  virtual std::shared_ptr<AsyncControl> UnloadEngineAsync(
      const std::string& id,
      const std::shared_ptr<void>& context) = 0;
 
  virtual std::shared_ptr<AsyncControl> AddEngineAsync(
      const FileEngine::Settings& settings,
      const std::shared_ptr<void>& context) = 0;
 
  virtual std::shared_ptr<AsyncControl> DeleteEngineAsync(
      const std::string& id,
      const std::shared_ptr<void>& context) = 0;
 
  virtual void AcquirePolicyAuthToken(Cloud cloud, const std::shared_ptr<AuthDelegate>& authDelegate) const = 0;
 
protected:
  FileProfile() {}
};
 
MIP_NAMESPACE_END
 
#endif  // API_MIP_FILE_FILE_PROFILE_H_