diff Common/IStorage.h @ 78:d7295e8678d7

renames
author Alain Mazy <am@osimis.io>
date Fri, 14 Oct 2022 11:00:18 +0200
parents Common/IStoragePlugin.h@80792bb9600e
children 407bd022b0cf
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Common/IStorage.h	Fri Oct 14 11:00:18 2022 +0200
@@ -0,0 +1,83 @@
+/**
+ * Cloud storage plugins for Orthanc
+ * Copyright (C) 2020-2021 Osimis S.A., Belgium
+ *
+ * This program is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+
+#pragma once
+
+#include <orthanc/OrthancCPlugin.h>
+#include <OrthancPluginCppWrapper.h>
+
+class StoragePluginException : public std::runtime_error
+{
+public:
+  StoragePluginException(const std::string& what)
+    : std::runtime_error(what)
+  {
+  }
+};
+
+
+
+
+// each "plugin" must also provide these global methods
+//class XXXStoragePluginFactory
+//{
+//public:
+//  const char* GetStoragePluginName();
+//  IStorage* CreateStorage(const OrthancPlugins::OrthancConfiguration& orthancConfig);
+//};
+
+class IStorage
+{
+public:
+  class IWriter
+  {
+  public:
+    IWriter()
+    {}
+
+    virtual ~IWriter() {}
+    virtual void Write(const char* data, size_t size) = 0;
+  };
+
+  class IReader
+  {
+  public:
+    IReader()
+    {}
+
+    virtual ~IReader() {}
+    virtual size_t GetSize() = 0;
+    virtual void ReadWhole(char* data, size_t size) = 0;
+    virtual void ReadRange(char* data, size_t size, size_t fromOffset) = 0;
+  };
+
+  std::string nameForLogs_;
+public:
+  IStorage(const std::string& nameForLogs):
+    nameForLogs_(nameForLogs)
+  {}
+
+  virtual void SetRootPath(const std::string& rootPath) = 0;
+
+  virtual IWriter* GetWriterForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) = 0;
+  virtual IReader* GetReaderForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) = 0;
+  virtual void DeleteObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) = 0;  // returns true only if 100% sure that the file has been deleted, false otherwise
+
+  const std::string& GetNameForLogs() {return nameForLogs_;}
+};