annotate Core/FileStorage/IStorageArea.h @ 2486:ad8f30fc28d1

new error code: DatabaseUnavailable
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 07 Mar 2018 15:46:47 +0100
parents 878b59270859
children 4e43e67f8ecf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1396
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1250
diff changeset
4 * Department, University Hospital of Liege, Belgium
2447
878b59270859 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
1126
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
36 #include "../Enumerations.h"
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
37
1396
ac4efabeb80c Migration of the orthanc-client as a separate project
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
38 #include <string>
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <boost/noncopyable.hpp>
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 class IStorageArea : public boost::noncopyable
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 public:
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 virtual ~IStorageArea()
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 }
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
1135
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
50 virtual void Create(const std::string& uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
51 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
52 size_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1126
diff changeset
53 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 virtual void Read(std::string& content,
1126
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
56 const std::string& uuid,
1250
2ffe07abd9d8 removal of const on IStorageArea::Read()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
57 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
1126
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
59 virtual void Remove(const std::string& uuid,
bf67431a7383 handling of file content type in IStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1125
diff changeset
60 FileContentType type) = 0;
1125
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 };
20ddab7e9ae8 IStorageArea abstraction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 }