Mercurial > hg > orthanc-object-storage

comparison Common/IStorage.h @ 78:d7295e8678d7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
renames
author Alain Mazy <am@osimis.io>
date Fri, 14 Oct 2022 11:00:18 +0200
parents Common/IStoragePlugin.h@80792bb9600e
children 407bd022b0cf
comparison
equal deleted inserted replaced
77:80792bb9600e 78:d7295e8678d7
1 /**
2 * Cloud storage plugins for Orthanc
3 * Copyright (C) 2020-2021 Osimis S.A., Belgium
4 *
5 * This program is free software: you can redistribute it and/or
6 * modify it under the terms of the GNU Affero General Public License
7 * as published by the Free Software Foundation, either version 3 of
8 * the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Affero General Public License for more details.
14 *
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 **/
18
19
20 #pragma once
21
22 #include <orthanc/OrthancCPlugin.h>
23 #include <OrthancPluginCppWrapper.h>
24
25 class StoragePluginException : public std::runtime_error
26 {
27 public:
28 StoragePluginException(const std::string& what)
29 : std::runtime_error(what)
30 {
31 }
32 };
33
34
35
36
37 // each "plugin" must also provide these global methods
38 //class XXXStoragePluginFactory
39 //{
40 //public:
41 // const char* GetStoragePluginName();
42 // IStorage* CreateStorage(const OrthancPlugins::OrthancConfiguration& orthancConfig);
43 //};
44
45 class IStorage
46 {
47 public:
48 class IWriter
49 {
50 public:
51 IWriter()
52 {}
53
54 virtual ~IWriter() {}
55 virtual void Write(const char* data, size_t size) = 0;
56 };
57
58 class IReader
59 {
60 public:
61 IReader()
62 {}
63
64 virtual ~IReader() {}
65 virtual size_t GetSize() = 0;
66 virtual void ReadWhole(char* data, size_t size) = 0;
67 virtual void ReadRange(char* data, size_t size, size_t fromOffset) = 0;
68 };
69
70 std::string nameForLogs_;
71 public:
72 IStorage(const std::string& nameForLogs):
73 nameForLogs_(nameForLogs)
74 {}
75
76 virtual void SetRootPath(const std::string& rootPath) = 0;
77
78 virtual IWriter* GetWriterForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) = 0;
79 virtual IReader* GetReaderForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) = 0;
80 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
81
82 const std::string& GetNameForLogs() {return nameForLogs_;}
83 };