mip_context.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_MIP_CONTEXT_H_
#define API_MIP_MIP_CONTEXT_H_
 
#include <map>
#include <memory>
 
#include "mip/common_types.h"
#include "mip/diagnostic_configuration.h"
#include "mip/flighting_feature.h"
#include "mip/json_delegate.h"
#include "mip/logger_delegate.h"
#include "mip/mip_configuration.h"
#include "mip/mip_export.h"
#include "mip/mip_namespace.h"
#include "mip/telemetry_delegate.h"
#include "mip/xml_delegate.h"
 
MIP_NAMESPACE_BEGIN
 
class AuditManager;
class ProtectionCloudManager;
class PolicyCloudManager;
class OneDSCloudManager;
class TelemetryManager;
struct DiagnosticClientHandle {
  DiagnosticClientHandle() {}
  DiagnosticClientHandle(const char *diagnosticType, int64_t diagnosticHandle)
    : type(diagnosticType),
      handle(diagnosticHandle) {}
 
  const char *type = {};
  int64_t handle = {};
};
class MipContext {
public:
 
#ifndef MIP_CORE_PACKAGE
#if !defined(SWIG) && !defined(SWIG_DIRECTORS)
    [[deprecated("MipContext::Create(...) is deprecated, use MipContext::Create(const std::shared_ptr<const MipConfiguration>&)")]]
#endif
   MIP_API static std::shared_ptr<MipContext> __CDECL Create(
      const ApplicationInfo& appInfo,
      const std::string& path,
      LogLevel thresholdLogLevel,
      bool isOfflineOnly,
      const std::shared_ptr<LoggerDelegate>& loggerDelegateOverride,
      const std::shared_ptr<DiagnosticConfiguration>& diagnosticOverride);
 
#if !defined(SWIG) && !defined(SWIG_DIRECTORS)
    [[deprecated("MipContext::CreateWithCustomFeatureSettings is deprecated, use MipContext::Create(const std::shared_ptr<const MipConfiguration>&)")]]
#endif
  MIP_API static std::shared_ptr<MipContext> __CDECL CreateWithCustomFeatureSettings(
      const ApplicationInfo& appInfo,
      const std::string& path,
      LogLevel thresholdLogLevel,
      bool isOfflineOnly,
      const std::shared_ptr<LoggerDelegate>& loggerDelegateOverride,
      const std::shared_ptr<DiagnosticConfiguration>& diagnosticOverride,
      const std::map<FlightingFeature, bool>& featureSettingsOverride);
#endif // !MIP_CORE_PACKAGE
 
  MIP_API static std::shared_ptr<MipContext> __CDECL Create(
      const std::shared_ptr<const MipConfiguration>& configuration);
 
  virtual void ShutDown() = 0;
 
  virtual bool IsFeatureEnabled(FlightingFeature feature) const = 0;
 
  virtual const ApplicationInfo& GetApplicationInfo() const = 0;
 
  virtual const std::string& GetMipPath() const = 0;
 
  virtual bool IsOfflineOnly() const = 0;
  
  virtual LogLevel GetThresholdLogLevel() const = 0;
 
  virtual std::shared_ptr<LoggerDelegate> GetLoggerDelegate() const = 0;
 
  virtual std::shared_ptr<HttpDelegate> GetHttpDelegate() const = 0;
 
  virtual LoggerDelegate* GetRawLoggerDelegate() const = 0;
 
  virtual std::shared_ptr<StorageDelegate> GetStorageDelegate() const = 0;
 
  virtual const std::map<FlightingFeature, bool>& GetFlightingFeatures() const = 0;
 
  virtual const std::shared_ptr<const MipConfiguration>& GetMipConfiguration() const = 0;
 
  virtual const LoggerConfiguration& GetLoggerConfiguration() const = 0;
 
  virtual const ProtectionCloudManager& GetProtectionCloudManager() const = 0;
  virtual const PolicyCloudManager& GetPolicyCloudManager() const = 0;
  virtual const OneDSCloudManager& GetOneDSCloudManager() const = 0;
  virtual std::shared_ptr<TelemetryManager> GetTelemetryManager() const = 0;
  virtual std::shared_ptr<AuditManager> GetAuditManager() const = 0;
  virtual TelemetryManager* GetRawTelemetryManager() const = 0;
  virtual std::shared_ptr<JsonDelegate> GetJsonDelegate() const = 0;
  virtual DiagnosticClientHandle AddDiagnosticClient(Cloud cloud, DataBoundary dataBoundary) const = 0;
  virtual const std::shared_ptr<EventContext> GetDefaultEventContext() const = 0;
 
  virtual std::shared_ptr<xml::XmlDelegate> GetXmlDelegate() const = 0;
  virtual ~MipContext() {}
};
 
MIP_NAMESPACE_END
#endif  // API_MIP_MIP_CONTEXT_H_