Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
FileHandler::Observer Class Reference

Observer interface for clients to get notifications events related to file handler. More...

#include <src/api/mip/file/file_handler.h>

Public Member Functions

virtual void OnClassifyFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when classify failed.
 
virtual void OnClassifySuccess (const std::vector< std::shared_ptr< Action > > &actions, const std::shared_ptr< void > &context)
 Called when classify success.
 
virtual void OnCommitFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when committing the changes to the file failed.
 
virtual void OnCommitSuccess (bool committed, const std::shared_ptr< void > &context)
 Called when committing the changes to the file were successful.
 
virtual void OnCreateFileHandlerFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when creating the handler failed.
 
virtual void OnCreateFileHandlerSuccess (const std::shared_ptr< FileHandler > &fileHandler, const std::shared_ptr< void > &context)
 Called when the handler is created successfully.
 
virtual void OnGetDecryptedTemporaryFileFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary file failed.
 
virtual void OnGetDecryptedTemporaryFileSuccess (const std::string &decryptedFilePath, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary file success.
 
virtual void OnGetDecryptedTemporaryStreamFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary stream failed.
 
virtual void OnGetDecryptedTemporaryStreamSuccess (const std::shared_ptr< Stream > &decryptedStream, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary stream success.
 
virtual void OnInspectFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when inspect failed.
 
virtual void OnInspectSuccess (const std::shared_ptr< FileInspector > &fileInspector, const std::shared_ptr< void > &context)
 Called when inspect success.
 

Detailed Description

Observer interface for clients to get notifications events related to file handler.

Note
All errors inherit from mip::Error.
Client should not call the engine back on the thread that calls the observer.

Definition at line 61 of file file_handler.h.

Member Function Documentation

◆ OnClassifyFailure()

virtual void FileHandler::Observer::OnClassifyFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when classify failed.

Definition at line 93 of file file_handler.h.

93 {
94 UNUSED(error);
95 UNUSED(context);
96 }

◆ OnClassifySuccess()

virtual void FileHandler::Observer::OnClassifySuccess ( const std::vector< std::shared_ptr< Action > > & actions,
const std::shared_ptr< void > & context )
inlinevirtual

Called when classify success.

Definition at line 84 of file file_handler.h.

85 {
86 UNUSED(actions);
87 UNUSED(context);
88 }

◆ OnCommitFailure()

virtual void FileHandler::Observer::OnCommitFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when committing the changes to the file failed.

Definition at line 143 of file file_handler.h.

145 { UNUSED(error); UNUSED(context); }

◆ OnCommitSuccess()

virtual void FileHandler::Observer::OnCommitSuccess ( bool committed,
const std::shared_ptr< void > & context )
inlinevirtual

Called when committing the changes to the file were successful.

Definition at line 136 of file file_handler.h.

138 { UNUSED(committed); UNUSED(context); }

◆ OnCreateFileHandlerFailure()

virtual void FileHandler::Observer::OnCreateFileHandlerFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when creating the handler failed.

Definition at line 77 of file file_handler.h.

79 { UNUSED(error); UNUSED(context); }

◆ OnCreateFileHandlerSuccess()

virtual void FileHandler::Observer::OnCreateFileHandlerSuccess ( const std::shared_ptr< FileHandler > & fileHandler,
const std::shared_ptr< void > & context )
inlinevirtual

Called when the handler is created successfully.

Definition at line 70 of file file_handler.h.

72 { UNUSED(fileHandler); UNUSED(context); }

◆ OnGetDecryptedTemporaryFileFailure()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryFileFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary file failed.

Definition at line 110 of file file_handler.h.

110 {
111 UNUSED(error);
112 UNUSED(context);
113 }

◆ OnGetDecryptedTemporaryFileSuccess()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryFileSuccess ( const std::string & decryptedFilePath,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary file success.

Definition at line 101 of file file_handler.h.

102 {
103 UNUSED(decryptedFilePath);
104 UNUSED(context);
105 }

◆ OnGetDecryptedTemporaryStreamFailure()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryStreamFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary stream failed.

Definition at line 127 of file file_handler.h.

128 {
129 UNUSED(error);
130 UNUSED(context);
131 }

◆ OnGetDecryptedTemporaryStreamSuccess()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryStreamSuccess ( const std::shared_ptr< Stream > & decryptedStream,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary stream success.

Definition at line 118 of file file_handler.h.

119 {
120 UNUSED(decryptedStream);
121 UNUSED(context);
122 }

◆ OnInspectFailure()

virtual void FileHandler::Observer::OnInspectFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when inspect failed.

Definition at line 159 of file file_handler.h.

159 {
160 UNUSED(error);
161 UNUSED(context);
162 }

◆ OnInspectSuccess()

virtual void FileHandler::Observer::OnInspectSuccess ( const std::shared_ptr< FileInspector > & fileInspector,
const std::shared_ptr< void > & context )
inlinevirtual

Called when inspect success.

Definition at line 150 of file file_handler.h.

151 {
152 UNUSED(fileInspector);
153 UNUSED(context);
154 }

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