Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
|
Configuration used by MIP sdk during its creation and throughout its lifetime. More...
#include <src/api/mip/mip_configuration.h>
Public Member Functions | |
size_t | GetApiLogCacheMaxMessages () const |
Get the max messages per Api call that will be logged in the api log cache. | |
const ApplicationInfo & | GetApplicationInfo () const |
Get the Description of host application. | |
std::shared_ptr< DiagnosticConfiguration > | GetDiagnosticConfiguration () const |
Get the Diagnostic (if any) provided by the application. | |
std::map< FlightingFeature, bool > | GetFeatureSettings () const |
Get the Flighting features which should be set to non-default values. | |
std::shared_ptr< HttpDelegate > | GetHttpDelegate () const |
Get the HttpDelegate (if any) override implementation. | |
std::shared_ptr< JsonDelegate > | GetJsonDelegate () const |
Get the JsonDelegate (if any) override implementation. | |
std::shared_ptr< LoggerConfiguration > | GetLoggerConfiguration () const |
Get the override configuration (if any) for the default logger implementation. | |
std::shared_ptr< LoggerDelegate > | GetLoggerDelegate () const |
Get the LoggerDelegate (if any) override implementation. | |
const std::string & | GetPath () const |
Get the File path for logs, caches, etc. | |
std::shared_ptr< StorageDelegate > | GetStorageDelegate () const |
Get the StorageDelegate (if any) override implementation. | |
const LogLevel & | GetThresholdLogLevel () const |
Get the Minimum log level for .miplog. | |
std::shared_ptr< xml::XmlDelegate > | GetXmlDelegate () const |
Get the XmlDelegate (if any) override implementation. | |
const bool | isOfflineOnly () const |
whether Network operations is enabled or disabled(not all actions supported when offline) | |
MipConfiguration (const ApplicationInfo &appInfo, const std::string &path, LogLevel thresholdLogLevel, bool isOfflineOnly) | |
void | SetApiLogCacheMaxMessages (size_t maxMessages) |
Set the max messages per Api call that will be logged in the api log cache. | |
void | SetDiagnosticConfiguration (const std::shared_ptr< DiagnosticConfiguration > &diagnosticConfiguration) |
Override default configuration of diagnostic. | |
void | SetFeatureSettings (const std::map< FlightingFeature, bool > &featureSettings) |
Set the Flighting features which should be set to non-default values. | |
void | SetHttpDelegate (const std::shared_ptr< HttpDelegate > &httpDelegate) |
Set the HttpDelegate (if any) override implementation. | |
void | SetLoggerConfiguration (const std::shared_ptr< LoggerConfiguration > &loggerConfiguration) |
Override the default logger configuration. | |
void | SetLoggerDelegate (const std::shared_ptr< LoggerDelegate > &loggerDelegate) |
Set the LoggerDelegate (if any) override implementation. | |
void | SetStorageDelegate (const std::shared_ptr< StorageDelegate > &storageDelegate) |
Set the StorageDelegate (if any) override implementation. | |
~MipConfiguration () | |
Protected Attributes | |
std::shared_ptr< JsonDelegate > | mJsonDelegate |
std::shared_ptr< xml::XmlDelegate > | mXmlDelegate |
Configuration used by MIP sdk during its creation and throughout its lifetime.
Definition at line 53 of file mip_configuration.h.
|
inline |
Definition at line 55 of file mip_configuration.h.
|
inline |
Definition at line 210 of file mip_configuration.h.
|
inline |
Get the max messages per Api call that will be logged in the api log cache.
Definition at line 201 of file mip_configuration.h.
|
inline |
Get the Description of host application.
Definition at line 72 of file mip_configuration.h.
|
inline |
Get the Diagnostic (if any) provided by the application.
Definition at line 99 of file mip_configuration.h.
|
inline |
Get the Flighting features which should be set to non-default values.
Definition at line 187 of file mip_configuration.h.
|
inline |
Get the HttpDelegate (if any) override implementation.
Definition at line 155 of file mip_configuration.h.
|
inline |
Get the JsonDelegate (if any) override implementation.
Definition at line 169 of file mip_configuration.h.
References mJsonDelegate.
|
inline |
Get the override configuration (if any) for the default logger implementation.
Definition at line 127 of file mip_configuration.h.
|
inline |
Get the LoggerDelegate (if any) override implementation.
Definition at line 113 of file mip_configuration.h.
|
inline |
Get the File path for logs, caches, etc.
Definition at line 79 of file mip_configuration.h.
|
inline |
Get the StorageDelegate (if any) override implementation.
Definition at line 141 of file mip_configuration.h.
|
inline |
Get the Minimum log level for .miplog.
Definition at line 86 of file mip_configuration.h.
|
inline |
Get the XmlDelegate (if any) override implementation.
MipConfiguration needs to be derived from to override the internal xmlDelegate with an alternative. This delegate is only configurable when using the MIP Core Context and only for the protection and upe sdk.
Definition at line 180 of file mip_configuration.h.
References mXmlDelegate.
|
inline |
whether Network operations is enabled or disabled(not all actions supported when offline)
Definition at line 93 of file mip_configuration.h.
|
inline |
Set the max messages per Api call that will be logged in the api log cache.
Setting this to 0 will disable api log caching
maxMessages |
Definition at line 208 of file mip_configuration.h.
|
inline |
Override default configuration of diagnostic.
diagnosticConfiguration | diagnostic configuration to be used for configuring telemetry/audit. |
Definition at line 106 of file mip_configuration.h.
|
inline |
Set the Flighting features which should be set to non-default values.
featureSettings | Flighting features to be used. |
Definition at line 194 of file mip_configuration.h.
|
inline |
Set the HttpDelegate (if any) override implementation.
It's a required delegate for MIP Core Context.
httpDelegate | HttpDelegate override implementation |
Definition at line 162 of file mip_configuration.h.
|
inline |
Override the default logger configuration.
loggerConfiguration | LoggerConfiguration override |
Definition at line 134 of file mip_configuration.h.
|
inline |
Set the LoggerDelegate (if any) override implementation.
loggerDelegate | LoggerDelegate override implementation |
Definition at line 120 of file mip_configuration.h.
|
inline |
Set the StorageDelegate (if any) override implementation.
It's a required delegate for MIP Core Context.
storageDelegate | StorageDelegate override implementation |
Definition at line 148 of file mip_configuration.h.
|
protected |
Definition at line 213 of file mip_configuration.h.
Referenced by GetJsonDelegate().
|
protected |
Definition at line 214 of file mip_configuration.h.
Referenced by GetXmlDelegate().