Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
policy_handler.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
33#ifndef API_MIP_UPE_POLICY_HANDLER_H_
34#define API_MIP_UPE_POLICY_HANDLER_H_
35
36#include <memory>
37#include <string>
38#include <vector>
39
40#include "mip/common_types.h"
41#include "mip/mip_context.h"
42#include "mip/mip_namespace.h"
43#include "mip/upe/action.h"
46#include "mip/upe/label.h"
48
49MIP_NAMESPACE_BEGIN
54public:
61 virtual std::shared_ptr<ContentLabel> GetSensitivityLabel(const ExecutionState& state) = 0;
62
70 virtual std::vector<std::shared_ptr<Action>> ComputeActions(const ExecutionState& state) = 0;
71
78 virtual void NotifyCommittedActions(const ExecutionState& state) = 0;
79
93 MIP_API static bool __CDECL IsLabeled(
94 const std::vector<MetadataEntry>& metadata,
95 const std::shared_ptr<MipContext>& mipContext);
96
111 MIP_API static bool __CDECL IsLabeled(
112 const std::vector<MetadataEntry>& metadata,
113 const std::shared_ptr<MipContext>& mipContext,
114 const std::shared_ptr<void>& loggerContext);
115
117 virtual ~PolicyHandler() {}
119};
120
121MIP_NAMESPACE_END
122
123#endif // API_MIP_UPE_POLICY_HANDLER_H_
A file containing the Action base class and the ActionType enumerator.
Interface for all the state needed to execute the engine.
Definition execution_state.h:70
This class provides an interface for all policy handler functions on a file.
Definition policy_handler.h:53
static MIP_API bool __CDECL IsLabeled(const std::vector< MetadataEntry > &metadata, const std::shared_ptr< MipContext > &mipContext, const std::shared_ptr< void > &loggerContext)
Checks whether metadata contains label artifacts.
static MIP_API bool __CDECL IsLabeled(const std::vector< MetadataEntry > &metadata, const std::shared_ptr< MipContext > &mipContext)
Checks whether metadata contains label artifacts.
virtual void NotifyCommittedActions(const ExecutionState &state)=0
Called once the computed actions have been applied, and the data committed to disk.
virtual std::shared_ptr< ContentLabel > GetSensitivityLabel(const ExecutionState &state)=0
Get the sensitivity label from existing content.
virtual std::vector< std::shared_ptr< Action > > ComputeActions(const ExecutionState &state)=0
Executes the rules in the handler based on the provided state and returns the list of actions to be e...
A file Containing the common types used by the upe, file and protection modules.
A file Containing the ContentLabel class.
This file contains the ExecutionState class.
This file contains the Label class.
This file contains the MetadataEntry class.
File containing definition of MipContext.
MIP namespace macros.