storage_delegate.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_STORAGE_DELEGATE_H_
#define API_MIP_STORAGE_DELEGATE_H_
 
#include <string>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/delegate_response.h"
#include "mip/mip_namespace.h"
#include "mip/storage_table.h"
 
MIP_NAMESPACE_BEGIN
 
enum class MipComponent : unsigned int {
  Policy   = 0, /* For Policy sdk */
  File    = 1, /* For File sdk */
  Protection = 2, /* For Protection sdk */
  Core = 3, /* For MIP Core*/
};
 
typedef mip::DelegateResponse<mip::StorageTable> StorageTableResult;
 
class StorageDelegate {
public:
 
  virtual mip::StorageTableResult CreateStorageTable(
      const std::string& path,
      const MipComponent mipComponent,
      const std::string& tableName,
      const std::vector<std::string>& allColumns,
      const std::vector<std::string>& encryptedColumns,
      const std::vector<std::string>& keyColumns) const = 0;
 
  class StorageSettings {
  public:
    StorageSettings(
        bool isRemoteStorage,
        bool isInMemoryStorageSupported,
        const std::string& onDiskExtension = GetSqliteExtension(),
        StorageTableVersion storageTableVersion = StorageTableVersion::One)
        : mIsRemoteStorage(isRemoteStorage),
          mIsInMemoryStorageSupported(isInMemoryStorageSupported),
          mOnDiskExtension(onDiskExtension),
          mStorageTableVersion(static_cast<unsigned int>(storageTableVersion)) {
      if (mStorageTableVersion < static_cast<unsigned int>(StorageTableVersion::One) || mStorageTableVersion > static_cast<unsigned int>(StorageTableVersion::Two)) {
        throw std::invalid_argument("Storage table version must be between StorageTableVersion::One and StorageTableVersion::Two");
      }
    }
 
    bool IsRemoteStorage() const { return mIsRemoteStorage; }
 
    bool IsInMemoryStorageSupported() const { return mIsInMemoryStorageSupported; }
    
    std::string OnDiskExtension() const { return mOnDiskExtension; }
 
    unsigned int GetStorageTableVersion() const { return mStorageTableVersion; }
 
    ~StorageSettings() { }
    StorageSettings() : StorageSettings(false, true, GetSqliteExtension()) {}
  private:
    bool mIsRemoteStorage;
    bool mIsInMemoryStorageSupported;
    std::string mOnDiskExtension;
    unsigned int mStorageTableVersion;
  };
 
  virtual StorageSettings GetSettings() const = 0;
 
  virtual ~StorageDelegate() {}
 
protected:
  StorageDelegate() {}
};
 
MIP_NAMESPACE_END
#endif // API_MIP_STORAGE_DELEGATE_H_