Share via

Implement ExecutionState

Passing information into the MIP SDK to compute an action that should be taken, based on the current state and desired state, is implemented via the mip::ExecutionState class. Like other classes in the SDK, the ExecutionState is an abstract class and must be implemented by the developer.

For a complete example of an ExecutionState implementation, review the following sample source:

mip::ExecutionState Members

ExecutionState exposes the following virtual members. Each provides some context to the policy engine to return information on which actions ought to be taken by the application. Additionally, this information may be used to provide audit information to the Azure Information Protection Reporting feature.

Member Returns
std::shared_ptr<mip::Label> GetNewLabel() Returns the label to be applied to the object.
mip::DataState GetDataState() Returns the mip::DataState of the object.
std::pair<bool, std::string> IsDowngradeJustified() Returns a std::pair expressing whether downgrade is justified and the justification.
std::string GetContentIdentifier() Returns the content identifier. Should be a human-readable identifier, indicating the location of the object.
mip::ActionSource GetNewLabelActionSource() Returns the mip::ActionSource of the label.
mip::AssignmentMethod GetNewLabelAssignmentMethod() Returns the mip::AssignmentMethod of the label
std::vector<std::pair<std::string, std::string>> GetNewLabelExtendedProperties() Returns a std::vector of std::pairs of strings, containing the custom metadata that will be applied to the document.
std::vector<std::pair<std::string, std::string>> GetContentMetadata() Returns a std::vector of std::pairs of string containing the current content metadata.
std::shared_ptr<mip::ProtectionDescriptor> GetProtectionDescriptor() Returns a pointer to a mip::ProtectionDescriptor
std::string GetContentFormat() Returns string
mip::ActionType GetSupportedActions() Returns mip::ActionTypes for the label.
std::shared_ptr<mip::ClassificationResults> Returns a list of classification results, if implemented.

Each must be overridden in an implementation of a class derived from mip::ExecutionState. In the sample application linked above, this process is accomplished by implementing a struct called ExecutionStateOptions, and passing that to the constructor of the derived class.

In the example, a struct called ExecutionStateOptions is defined as:

struct ExecutionStateOptions {
    std::unordered_map<std::string, std::string> metadata;
    std::string newLabelId;
    std::string contentIdentifier;
    mip::ActionSource actionSource = mip::ActionSource::MANUAL;
    mip::DataState dataState = mip::DataState::USE;
    mip::AssignmentMethod assignmentMethod = mip::AssignmentMethod::STANDARD;
    bool isDowngradeJustified = false;
    std::string downgradeJustification;
    std::string templateId;
    std::string contentFormat = mip::GetFileContentFormat();
    mip::ActionType supportedActions;
    bool generateAuditEvent;
};

Each property is set by the application, then ExecutionStateOptions is passed to the constructor of the class derived from mip::ExecutionState. This information is used to determine the actions to take. Data provided in the mip::ExecutionState will also surface in Azure Information Protection Analytics.

Next Steps