MipContext represents state that is shared across all profiles, engines, handlers. More...

#include <mip/mip_context.h>

Public Member Functions
virtual void	ShutDown ()=0
	Terminate MIP.

virtual bool	IsFeatureEnabled (FlightingFeature feature) const =0
	Gets whether or not a feature is enabled.

virtual const ApplicationInfo &	GetApplicationInfo () const =0
	Get application description.

virtual const std::string &	GetMipPath () const =0
	Get file path for logs, caches, etc.

virtual bool	IsOfflineOnly () const =0
	Get offline-only setting.

virtual LogLevel	GetThresholdLogLevel () const =0
	Get threshold log level.

virtual std::shared_ptr< LoggerDelegate >	GetLoggerDelegate () const =0
	Get logger implementation.

virtual std::shared_ptr< HttpDelegate >	GetHttpDelegate () const =0
	Get Http implementation.

virtual LoggerDelegate *	GetRawLoggerDelegate () const =0
	Get raw logger implementation.

virtual std::shared_ptr< StorageDelegate >	GetStorageDelegate () const =0
	Get Storage Delegate implementation if provided.

virtual std::shared_ptr< CloudDiscoveryDelegate >	GetCloudDiscoveryDelegate () const =0
	Get Cloud Discovery Delegate implementation if provided.

virtual const std::map< FlightingFeature, bool > &	GetFlightingFeatures () const =0
	Get flighting feature set.

virtual const std::shared_ptr< const MipConfiguration > &	GetMipConfiguration () const =0
	Gets the mip configuration that was used to create the MipContext.

virtual const LoggerConfiguration &	GetLoggerConfiguration () const =0
	Gets the logger configuration that will be used by the default logger.

virtual std::shared_ptr< CacheStorageType >	GetCacheStorageType () const =0
	Get whether caches are stored in memory or on disk.

virtual std::shared_ptr< ProtectionCloudManager >	GetProtectionCloudManager () const =0

virtual std::shared_ptr< PolicyCloudManager >	GetPolicyCloudManager () const =0

virtual std::shared_ptr< 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 std::shared_ptr< OneDSAriaHelper >	GetOneDSAriaHelper () const =0

virtual std::shared_ptr< EventContext >	GetDefaultEventContext () const =0

virtual void	InitializeCloudDiscoveryStores (const CacheStorageType cacheStorageType)=0

virtual std::shared_ptr< xml::XmlDelegate >	GetXmlDelegate () const =0
	Get the Xml Delegate that should be used when parsing. If the application provides a MipConfiguration with an xml delegate and is using MipCore this method returns that alternative delegate. Otherwise the default implementation will be used.

virtual	~MipContext ()

Static Public Member Functions
static MIP_API 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)
	Create a new MipContext instance to be used when initializing profiles.

static MIP_API 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)
	Create a new MipContext instance with custom feature settings.

static MIP_API std::shared_ptr< MipContext > __CDECL	Create (const std::shared_ptr< const MipConfiguration > &configuration)
	Create a new MipContext instance with mip configuration.

Detailed Description

MipContext represents state that is shared across all profiles, engines, handlers.

Constructor & Destructor Documentation

◆ ~MipContext()

virtual MipContext::~MipContext ( )

inlinevirtual

Member Function Documentation

◆ Create() [1/2]

static MIP_API std::shared_ptr< MipContext > __CDECL MipContext::Create	(	const ApplicationInfo &	appInfo,
		const std::string &	path,
		LogLevel	thresholdLogLevel,
		bool	isOfflineOnly,
		const std::shared_ptr< LoggerDelegate > &	loggerDelegateOverride,
		const std::shared_ptr< DiagnosticConfiguration > &	diagnosticOverride )

static

Create a new MipContext instance to be used when initializing profiles.

Parameters

appInfo	Description of host application
path	File path for logs, caches, etc.
thresholdLogLevel	Minimum log level for .miplog
isOfflineOnly	Enable/disable network operations (not all actions supported when offline)
loggerDelegateOverride	(Optional) LoggerDelegate override implementation
diagnosticOverride	(Optional) DiagnosticConfiguration override for audit/telemetry

Returns: MipContext instance

◆ Create() [2/2]

static MIP_API std::shared_ptr< MipContext > __CDECL MipContext::Create ( const std::shared_ptr< const MipConfiguration > & configuration )

static

Create a new MipContext instance with mip configuration.

Parameters

mipConfiguration mipConfiguration to be used across MIP

Returns: MipContext instance

◆ CreateWithCustomFeatureSettings()

static MIP_API std::shared_ptr< MipContext > __CDECL MipContext::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 )

static

Create a new MipContext instance with custom feature settings.

Parameters

appInfo	Description of host application
path	File path for logs, caches, etc.
thresholdLogLevel	Minimum log level for .miplog
isOfflineOnly	Enable/disable network operations (not all actions supported when offline)
loggerDelegateOverride	(Optional) LoggerDelegate override implementation
diagnosticOverride	(Optional) DiagnosticConfiguration override for audit/telemetry
featureSettingsOverride	Flighting features which should be set to non-default values

Returns: MipContext instance

◆ GetApplicationInfo()

virtual const ApplicationInfo & MipContext::GetApplicationInfo ( ) const

pure virtual

Get application description.

Returns: Application description

◆ GetAuditManager()

virtual std::shared_ptr< AuditManager > MipContext::GetAuditManager ( ) const

pure virtual

◆ GetCacheStorageType()

virtual std::shared_ptr< CacheStorageType > MipContext::GetCacheStorageType ( ) const

pure virtual

Get whether caches are stored in memory or on disk.

Returns: storage type used CacheStorageType

◆ GetCloudDiscoveryDelegate()

virtual std::shared_ptr< CloudDiscoveryDelegate > MipContext::GetCloudDiscoveryDelegate ( ) const

pure virtual

Get Cloud Discovery Delegate implementation if provided.

Returns: CloudDiscoveryDelegate

◆ GetDefaultEventContext()

virtual std::shared_ptr< EventContext > MipContext::GetDefaultEventContext ( ) const

pure virtual

◆ GetFlightingFeatures()

virtual const std::map< FlightingFeature, bool > & MipContext::GetFlightingFeatures ( ) const

pure virtual

Get flighting feature set.

Returns: Flighting feature map

◆ GetHttpDelegate()

virtual std::shared_ptr< HttpDelegate > MipContext::GetHttpDelegate ( ) const

pure virtual

Get Http implementation.

Returns: HttpDelegate

◆ GetJsonDelegate()

virtual std::shared_ptr< JsonDelegate > MipContext::GetJsonDelegate ( ) const

pure virtual

◆ GetLoggerConfiguration()

virtual const LoggerConfiguration & MipContext::GetLoggerConfiguration ( ) const

pure virtual

Gets the logger configuration that will be used by the default logger.

Returns: Logger configuration

◆ GetLoggerDelegate()

virtual std::shared_ptr< LoggerDelegate > MipContext::GetLoggerDelegate ( ) const

pure virtual

Get logger implementation.

Returns: Logger

◆ GetMipConfiguration()

virtual const std::shared_ptr< const MipConfiguration > & MipContext::GetMipConfiguration ( ) const

pure virtual

Gets the mip configuration that was used to create the MipContext.

Returns: The mip configuration

◆ GetMipPath()

virtual const std::string & MipContext::GetMipPath ( ) const

pure virtual

Get file path for logs, caches, etc.

Returns: File path (with "mip" leaf directory)

◆ GetOneDSAriaHelper()

virtual std::shared_ptr< OneDSAriaHelper > MipContext::GetOneDSAriaHelper ( ) const

pure virtual

◆ GetOneDSCloudManager()

virtual std::shared_ptr< OneDSCloudManager > MipContext::GetOneDSCloudManager ( ) const

pure virtual

◆ GetPolicyCloudManager()

virtual std::shared_ptr< PolicyCloudManager > MipContext::GetPolicyCloudManager ( ) const

pure virtual

◆ GetProtectionCloudManager()

virtual std::shared_ptr< ProtectionCloudManager > MipContext::GetProtectionCloudManager ( ) const

pure virtual

◆ GetRawLoggerDelegate()

virtual LoggerDelegate * MipContext::GetRawLoggerDelegate ( ) const

pure virtual

Get raw logger implementation.

Returns: Logger

◆ GetRawTelemetryManager()

virtual TelemetryManager * MipContext::GetRawTelemetryManager ( ) const

pure virtual

◆ GetStorageDelegate()

virtual std::shared_ptr< StorageDelegate > MipContext::GetStorageDelegate ( ) const

pure virtual

Get Storage Delegate implementation if provided.

Returns: StorageDelegate

◆ GetTelemetryManager()

virtual std::shared_ptr< TelemetryManager > MipContext::GetTelemetryManager ( ) const

pure virtual

◆ GetThresholdLogLevel()

virtual LogLevel MipContext::GetThresholdLogLevel ( ) const

pure virtual

Get threshold log level.

Returns: threshold log level

◆ GetXmlDelegate()

virtual std::shared_ptr< xml::XmlDelegate > MipContext::GetXmlDelegate ( ) const

pure virtual

Get the Xml Delegate that should be used when parsing. If the application provides a MipConfiguration with an xml delegate and is using MipCore this method returns that alternative delegate. Otherwise the default implementation will be used.

Returns: A shared_ptr to the xml delegate

◆ InitializeCloudDiscoveryStores()

virtual void MipContext::InitializeCloudDiscoveryStores ( const CacheStorageType cacheStorageType )

pure virtual

◆ IsFeatureEnabled()

virtual bool MipContext::IsFeatureEnabled ( FlightingFeature feature ) const

pure virtual

Gets whether or not a feature is enabled.

Parameters

feature Feature to enable/disable

Returns: Whether or not a feature is enabled

Note: If a FeatureFlightingDelegate has not been provided by an application, this will always return true

◆ IsOfflineOnly()

virtual bool MipContext::IsOfflineOnly ( ) const

pure virtual

Get offline-only setting.

Returns: Whether or not application is running in offline-only mode

◆ ShutDown()

virtual void MipContext::ShutDown ( )

pure virtual

Terminate MIP.

Note: This method must be called prior to process/DLL shutdown

The documentation for this class was generated from the following file:

src/api/mip/mip_context.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~MipContext()

Member Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateWithCustomFeatureSettings()

◆ GetApplicationInfo()

◆ GetAuditManager()

◆ GetCacheStorageType()

◆ GetCloudDiscoveryDelegate()

◆ GetDefaultEventContext()

◆ GetFlightingFeatures()

◆ GetHttpDelegate()

◆ GetJsonDelegate()

◆ GetLoggerConfiguration()

◆ GetLoggerDelegate()

◆ GetMipConfiguration()

◆ GetMipPath()

◆ GetOneDSAriaHelper()

◆ GetOneDSCloudManager()

◆ GetPolicyCloudManager()

◆ GetProtectionCloudManager()

◆ GetRawLoggerDelegate()

◆ GetRawTelemetryManager()

◆ GetStorageDelegate()

◆ GetTelemetryManager()

◆ GetThresholdLogLevel()

◆ GetXmlDelegate()

◆ InitializeCloudDiscoveryStores()

◆ IsFeatureEnabled()

◆ IsOfflineOnly()

◆ ShutDown()