This class provides an interface for all engine functions. More...

#include <mip/file/file_engine.h>

Classes
class	Settings

Public Member Functions
virtual	~FileEngine ()

virtual const Settings &	GetSettings () const =0
	Returns the engine settings.

virtual const std::vector< std::shared_ptr< SensitivityTypesRulePackage > > &	ListSensitivityTypes () const =0
	list the sensitivity types associated with the policy engine.

virtual const std::shared_ptr< Label >	GetDefaultSensitivityLabel () const =0
	Get the default sensitivity label.

virtual std::shared_ptr< Label >	GetLabelById (const std::string &id) const =0
	Gets the label according to the provided id.

virtual const std::vector< std::shared_ptr< Label > >	ListSensitivityLabels ()=0
	Returns a list of sensitivity labels.

virtual const std::string &	GetMoreInfoUrl () const =0
	Provide a url for looking up more information about the policy/labels.

virtual const std::string &	GetPolicyFileId () const =0
	Gets the policy file ID.

virtual const std::string &	GetSensitivityFileId () const =0
	Gets the sensitivity file ID.

virtual bool	IsLabelingRequired () const =0
	Checks if the policy dictates that a document must be labeled.

virtual std::chrono::time_point< std::chrono::system_clock >	GetLastPolicyFetchTime () const =0
	Gets the time when the policy was last fetched.

virtual const std::string &	GetPolicyDataXml () const =0
	Gets policy data XML which describes the settings, labels, and rules associated with this policy.

virtual std::shared_ptr< AsyncControl >	CreateFileHandlerAsync (const std::string &inputFilePath, const std::string &filePathForAuditReporting, bool isAuditDiscoveryEnabled, const std::shared_ptr< FileHandler::Observer > &fileHandlerObserver, const std::shared_ptr< void > &context, const std::shared_ptr< FileExecutionState > &fileExecutionState=nullptr, bool isGetSensitivityLabelAuditDiscoveryEnabled=true)=0
	Starts creating a file handler for given file path.

virtual std::shared_ptr< AsyncControl >	CreateFileHandlerAsync (const std::shared_ptr< Stream > &inputStream, const std::string &actualFilePath, bool isAuditDiscoveryEnabled, const std::shared_ptr< FileHandler::Observer > &fileHandlerObserver, const std::shared_ptr< void > &context, const std::shared_ptr< FileExecutionState > &fileExecutionState=nullptr, bool isGetSensitivityLabelAuditDiscoveryEnabled=true)=0
	Starts creating a file handler for given file stream.

virtual void	SendApplicationAuditEvent (const std::string &level, const std::string &eventType, const std::string &eventData)=0
	Logs an application specific event to the audit pipeline.

virtual const std::vector< std::pair< std::string, std::string > > &	GetCustomSettings () const =0
	Gets a list of custom settings.

virtual bool	HasClassificationRules () const =0
	Gets if the policy has automatic or recommendation rules.

virtual bool	HasWorkloadConsent (Workload workload) const =0
	Checks if user has consented to specific workload,.

virtual std::vector< std::string >	GetRightsForLabelId (const std::string &documentId, const std::string &labelId, const std::string &ownerEmail, const std::shared_ptr< void > &context, const ProtectionCommonSettings &settings=ProtectionCommonSettings()) const =0
	Get collection of rights available to a user for a label ID.

virtual std::shared_ptr< AsyncControl >	GetRightsForLabelIdAsync (const std::string &documentId, const std::string &labelId, const std::string &ownerEmail, const std::shared_ptr< class ProtectionEngine::Observer > &observer, const std::shared_ptr< void > &context, const ProtectionCommonSettings &settings=ProtectionCommonSettings()) const =0
	Get collection of rights available to a user for a label ID.

Protected Member Functions
	FileEngine ()

Detailed Description

This class provides an interface for all engine functions.

Constructor & Destructor Documentation

◆ ~FileEngine()

virtual FileEngine::~FileEngine ( )

inlinevirtual

◆ FileEngine()

FileEngine::FileEngine ( )

inlineprotected

Member Function Documentation

◆ CreateFileHandlerAsync() [1/2]

virtual std::shared_ptr< AsyncControl > FileEngine::CreateFileHandlerAsync	(	const std::shared_ptr< Stream > &	inputStream,
		const std::string &	actualFilePath,
		bool	isAuditDiscoveryEnabled,
		const std::shared_ptr< FileHandler::Observer > &	fileHandlerObserver,
		const std::shared_ptr< void > &	context,
		const std::shared_ptr< FileExecutionState > &	fileExecutionState = nullptr,
		bool	isGetSensitivityLabelAuditDiscoveryEnabled = true )

pure virtual

Starts creating a file handler for given file stream.

Parameters

inputStream	A stream containing the file data.
actualFilePath	The path to the file. The path must include the file name and, if one exists, the file extension. The file extension will be used to determine the file format. Passing in the wrong file extension will cause unexpected behavior and possibly file corruption. The path will also use to identify the file in audit.
isAuditDiscoveryEnabled	representing whether audit discovery is enabled or not.
fileHandlerObserver	A class implementing the FileHandler::Observer interface.
context	Client context that will be opaquely passed back to the observer.
isGetSensitivityLabelAuditDiscoveryEnabled	representing whether audit discovery is triggered for getSensitivityLabel or not.

Returns: Async control object.

◆ CreateFileHandlerAsync() [2/2]

virtual std::shared_ptr< AsyncControl > FileEngine::CreateFileHandlerAsync	(	const std::string &	inputFilePath,
		const std::string &	filePathForAuditReporting,
		bool	isAuditDiscoveryEnabled,
		const std::shared_ptr< FileHandler::Observer > &	fileHandlerObserver,
		const std::shared_ptr< void > &	context,
		const std::shared_ptr< FileExecutionState > &	fileExecutionState = nullptr,
		bool	isGetSensitivityLabelAuditDiscoveryEnabled = true )

pure virtual

Starts creating a file handler for given file path.

Parameters

inputFilePath	The file to open. The path must include the file name and, if one exists, the file extension. The file extension is used to determine the file format.
filePathForAuditReporting	The actual (not temporary) file path, will be used for audit.
isAuditDiscoveryEnabled	representing whether audit discovery is enabled or not.
fileHandlerObserver	A class implementing the FileHandler::Observer interface.
context	Client context that will be opaquely passed back to the observer.
isGetSensitivityLabelAuditDiscoveryEnabled	representing whether audit discovery is triggered for getSensitivityLabel or not.

Returns: Async control object.

◆ GetCustomSettings()

virtual const std::vector< std::pair< std::string, std::string > > & FileEngine::GetCustomSettings ( ) const

pure virtual

Gets a list of custom settings.

Returns: a vector of custom settings

◆ GetDefaultSensitivityLabel()

virtual const std::shared_ptr< Label > FileEngine::GetDefaultSensitivityLabel ( ) const

pure virtual

Get the default sensitivity label.

Returns: default sensitivity label if exists, nullptr if there is no default label set.

◆ GetLabelById()

virtual std::shared_ptr< Label > FileEngine::GetLabelById ( const std::string & id ) const

pure virtual

Gets the label according to the provided id.

◆ GetLastPolicyFetchTime()

virtual std::chrono::time_point< std::chrono::system_clock > FileEngine::GetLastPolicyFetchTime ( ) const

pure virtual

Gets the time when the policy was last fetched.

Returns: the time when the policy was last fetched

◆ GetMoreInfoUrl()

virtual const std::string & FileEngine::GetMoreInfoUrl ( ) const

pure virtual

Provide a url for looking up more information about the policy/labels.

Returns: a url in string format.

◆ GetPolicyDataXml()

virtual const std::string & FileEngine::GetPolicyDataXml ( ) const

pure virtual

Gets policy data XML which describes the settings, labels, and rules associated with this policy.

Returns: Policy data XML.

◆ GetPolicyFileId()

virtual const std::string & FileEngine::GetPolicyFileId ( ) const

pure virtual

Gets the policy file ID.

Returns: a string that represent the policy file ID

◆ GetRightsForLabelId()

virtual std::vector< std::string > FileEngine::GetRightsForLabelId	(	const std::string &	documentId,
		const std::string &	labelId,
		const std::string &	ownerEmail,
		const std::shared_ptr< void > &	context,
		const ProtectionCommonSettings &	settings = ProtectionCommonSettings() ) const

pure virtual

Get collection of rights available to a user for a label ID.

Parameters

documentId	Document ID associated with the document metadata.
labelId	Label ID associated with the document metadata with which the document was created.
ownerEmail	Owner of the document.
context	This same context will be forwarded to optional HttpDelegate.

Returns: List of rights.

◆ GetRightsForLabelIdAsync()

virtual std::shared_ptr< AsyncControl > FileEngine::GetRightsForLabelIdAsync	(	const std::string &	documentId,
		const std::string &	labelId,
		const std::string &	ownerEmail,
		const std::shared_ptr< class ProtectionEngine::Observer > &	observer,
		const std::shared_ptr< void > &	context,
		const ProtectionCommonSettings &	settings = ProtectionCommonSettings() ) const

pure virtual

Get collection of rights available to a user for a label ID.

Parameters

documentId	Document ID associated with the document metadata.
labelId	Label ID associated with the document metadata with which the document was created.
ownerEmail	Owner of the document.
observer	A class implementing the ProtectionEngine::Observer interface.
context	This same context will be forwarded to ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess or ProtectionEngine::Observer::OnGetRightsForLabelIdFailure.

Returns: Async control object.

◆ GetSensitivityFileId()

virtual const std::string & FileEngine::GetSensitivityFileId ( ) const

pure virtual

Gets the sensitivity file ID.

Returns: a string that represent the policy file ID

◆ GetSettings()

virtual const Settings & FileEngine::GetSettings ( ) const

pure virtual

Returns the engine settings.

◆ HasClassificationRules()

virtual bool FileEngine::HasClassificationRules ( ) const

pure virtual

Gets if the policy has automatic or recommendation rules.

Returns: a bool that will tell if there any automatic or recommendation rules in the policy

◆ HasWorkloadConsent()

virtual bool FileEngine::HasWorkloadConsent ( Workload workload ) const

pure virtual

Checks if user has consented to specific workload,.

Returns: bool indicating consent.

◆ IsLabelingRequired()

virtual bool FileEngine::IsLabelingRequired ( ) const

pure virtual

Checks if the policy dictates that a document must be labeled.

Returns: true if labeling is mandatory, else false.

◆ ListSensitivityLabels()

virtual const std::vector< std::shared_ptr< Label > > FileEngine::ListSensitivityLabels ( )

pure virtual

Returns a list of sensitivity labels.

◆ ListSensitivityTypes()

virtual const std::vector< std::shared_ptr< SensitivityTypesRulePackage > > & FileEngine::ListSensitivityTypes ( ) const

pure virtual

list the sensitivity types associated with the policy engine.

Returns: a list of sensitivity labels. empty if LoadSensitivityTypesEnabled was false (

See also: FileEngine::Settings).

◆ SendApplicationAuditEvent()

virtual void FileEngine::SendApplicationAuditEvent	(	const std::string &	level,
		const std::string &	eventType,
		const std::string &	eventData )

pure virtual

Logs an application specific event to the audit pipeline.

Parameters

level	a description of the log level : Info/Error/Warning
eventType	a description of the type of event
eventData	the data associated with the event

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

src/api/mip/file/file_engine.h

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~FileEngine()

◆ FileEngine()

Member Function Documentation

◆ CreateFileHandlerAsync() [1/2]

◆ CreateFileHandlerAsync() [2/2]

◆ GetCustomSettings()

◆ GetDefaultSensitivityLabel()

◆ GetLabelById()

◆ GetLastPolicyFetchTime()

◆ GetMoreInfoUrl()

◆ GetPolicyDataXml()

◆ GetPolicyFileId()

◆ GetRightsForLabelId()

◆ GetRightsForLabelIdAsync()

◆ GetSensitivityFileId()

◆ GetSettings()

◆ HasClassificationRules()

◆ HasWorkloadConsent()

◆ IsLabelingRequired()

◆ ListSensitivityLabels()

◆ ListSensitivityTypes()

◆ SendApplicationAuditEvent()