execution_state.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
#ifndef API_MIP_UPE_EXECUTION_STATE_H_
#define API_MIP_UPE_EXECUTION_STATE_H_
 
#include <map>
#include <memory>
#include <utility>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/mip_namespace.h"
#include "mip/protection_descriptor.h"
#include "mip/upe/action.h"
#include "mip/upe/classification_request.h"
#include "mip/upe/classification_result.h"
#include "mip/upe/label.h"
#include "mip/upe/metadata_entry.h"
#include "mip/upe/metadata_version.h"
 
MIP_NAMESPACE_BEGIN
 
namespace auditmetadatakeys {
 
  inline std::string Sender() { return "Sender"; }
  inline std::string Recipients() { return "Recipients"; }
  inline std::string LastModifiedBy() { return "LastModifiedBy"; }
  inline std::string LastModifiedDate() { return "LastModifiedDate"; }
}
 
class ExecutionState {
public:
  virtual std::shared_ptr<Label> GetNewLabel() const = 0;
 
  virtual std::string GetContentIdentifier() const = 0;
 
  virtual std::string GetApplicationScenarioId() const {
    return std::string();
  };
 
  virtual DataState GetDataState() const {
    return DataState::USE;
  };
 
  virtual std::pair<bool, std::string> IsDowngradeJustified() const = 0;
 
  virtual AssignmentMethod GetNewLabelAssignmentMethod() const = 0;
 
  virtual std::vector<std::pair<std::string, std::string>> GetNewLabelExtendedProperties() const { 
    return std::vector<std::pair<std::string, std::string>>();
  }
 
  virtual std::vector<MetadataEntry> GetContentMetadata(
      const std::vector<std::string>& names,
      const std::vector<std::string>& namePrefixes) const = 0;
 
  virtual std::shared_ptr<ProtectionDescriptor> GetProtectionDescriptor() const = 0;
 
  virtual std::string GetContentFormat() const = 0;
 
  virtual MetadataVersion GetContentMetadataVersion() const {
    return MetadataVersion(0, MetadataVersionFormat::DEFAULT);
  };
 
  virtual ActionType GetSupportedActions() const = 0;
 
  virtual std::shared_ptr<ClassificationResults> GetClassificationResults(
      const std::vector<std::shared_ptr<ClassificationRequest>>& /*classificationIds*/) const { 
    return nullptr;
  }
 
  virtual std::map<std::string, std::string> GetAuditMetadata() const { 
    return std::map<std::string, std::string>();
  }
 
  virtual ~ExecutionState() { }
 
protected:
  ExecutionState() { }
};
 
MIP_NAMESPACE_END
 
#endif  // API_MIP_UPE_EXECUTION_STATE_H_