annotate Resources/Orthanc/Core/WebServiceParameters.h @ 139:f2f58f288172

sync
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 11 Apr 2018 16:24:26 +0200
parents a18bfe1fdd62
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
116
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 98
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
dc730d11b101 orthanc dependencies
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
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
43
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
36 #if !defined(ORTHANC_SANDBOXED)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
37 # error The macro ORTHANC_SANDBOXED must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
38 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
39
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 #include <string>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 #include <json/json.h>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 namespace Orthanc
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 class WebServiceParameters
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 private:
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 bool advancedFormat_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 std::string url_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 std::string username_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 std::string password_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 std::string certificateFile_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 std::string certificateKeyFile_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 std::string certificateKeyPassword_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 bool pkcs11Enabled_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 void FromJsonArray(const Json::Value& peer);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 void FromJsonObject(const Json::Value& peer);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 public:
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 WebServiceParameters();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 const std::string& GetUrl() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 return url_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 void SetUrl(const std::string& url)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 url_ = url;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 const std::string& GetUsername() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 return username_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 void SetUsername(const std::string& username)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 username_ = username;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 const std::string& GetPassword() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 return password_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 void SetPassword(const std::string& password)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 password_ = password;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 void ClearClientCertificate();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
43
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
96 #if ORTHANC_SANDBOXED == 0
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 void SetClientCertificate(const std::string& certificateFile,
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 const std::string& certificateKeyFile,
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 const std::string& certificateKeyPassword);
43
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1
diff changeset
100 #endif
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 const std::string& GetCertificateFile() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 return certificateFile_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 const std::string& GetCertificateKeyFile() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 return certificateKeyFile_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 const std::string& GetCertificateKeyPassword() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 return certificateKeyPassword_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 void SetPkcs11Enabled(bool pkcs11Enabled)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 pkcs11Enabled_ = pkcs11Enabled;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 bool IsPkcs11Enabled() const
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 return pkcs11Enabled_;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 void FromJson(const Json::Value& peer);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 void ToJson(Json::Value& value) const;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 };
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 }