Mercurial > hg > orthanc

annotate OrthancServer/Plugins/Samples/Common/IOrthancConnection.h @ 4072:3dda0d73193c framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix doxygen, more tolerant WebServiceParameters::SetUrl()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 15 Jun 2020 16:28:03 +0200
parents d25f4c0fa160
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2179
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
2179
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
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
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "DicomPath.h"
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <boost/noncopyable.hpp>
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <string>
2180
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
40 #include <json/value.h>
2179
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 namespace OrthancPlugins
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 class IOrthancConnection : public boost::noncopyable
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 public:
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 virtual ~IOrthancConnection()
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 virtual void RestApiGet(std::string& result,
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 const std::string& uri) = 0;
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 virtual void RestApiPost(std::string& result,
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 const std::string& uri,
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const std::string& body) = 0;
2180
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
57
2183
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
58 virtual void RestApiPut(std::string& result,
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
59 const std::string& uri,
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
60 const std::string& body) = 0;
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
61
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
62 virtual void RestApiDelete(const std::string& uri) = 0;
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
63
2180
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
64 static void ParseJson(Json::Value& result,
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
65 const std::string& content);
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
66
2278
fd5869e3ed5e new constructors in FullOrthancDataset
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
67 static void ParseJson(Json::Value& result,
fd5869e3ed5e new constructors in FullOrthancDataset
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
68 const void* content,
fd5869e3ed5e new constructors in FullOrthancDataset
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
69 size_t size);
fd5869e3ed5e new constructors in FullOrthancDataset
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
70
2180
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
71 static void RestApiGet(Json::Value& result,
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
72 IOrthancConnection& orthanc,
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
73 const std::string& uri);
71b8bec8ca91 improvements
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2179
diff changeset
74
2181
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2180
diff changeset
75 static void RestApiPost(Json::Value& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2180
diff changeset
76 IOrthancConnection& orthanc,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2180
diff changeset
77 const std::string& uri,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2180
diff changeset
78 const std::string& body);
2183
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
79
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
80 static void RestApiPut(Json::Value& result,
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
81 IOrthancConnection& orthanc,
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
82 const std::string& uri,
1d0838b8e9c5 RestApiDelete and RestApiPut
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2181
diff changeset
83 const std::string& body);
2179
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 };
de32f3b4ff09 shared toolbox to access DICOM datasets from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 }