annotate OrthancServer/OrthancInitialization.h @ 807:566a2fb3c1fb

update/delete modalities
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 07 May 2014 15:54:23 +0200
parents 557575fd93e9
children 2d9a000aa3a6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
62
a70bb32802ae renaming Server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 58
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
689
2d0a347e8cfc switch to 2014
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 617
diff changeset
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Belgium
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
10 *
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
11 * In addition, as a special exception, the copyright holders of this
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
12 * program give permission to link the code of its release with the
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
15 * the linked executables. You must obey the GNU General Public License
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
19 * you do not wish to do so, delete this exception statement from your
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
20 * version. If you delete this exception statement from all source files
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
21 * in the program, then also delete it here.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include <string>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include <set>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <json/json.h>
270
e6a4c4329481 parameters for storage capacity
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
38 #include <stdint.h>
25
dd1489098265 basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 23
diff changeset
39 #include "../Core/HttpServer/MongooseServer.h"
773
3bd0589af992 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 772
diff changeset
40 #include "DicomProtocol/RemoteModalityParameters.h"
519
1b2cdc855bd3 Parameter for PACS manufacturer, support for ClearCanvas
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 484
diff changeset
41 #include "ServerEnumerations.h"
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
62
a70bb32802ae renaming Server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 58
diff changeset
43 namespace Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
806
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
45 class OrthancPeerParameters
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
46 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
47 private:
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
48 std::string name_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
49 std::string url_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
50 std::string username_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
51 std::string password_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
52
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
53 public:
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
54 OrthancPeerParameters() : url_("http://localhost:8042/")
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
55 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
56 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
57
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
58 const std::string& GetName() const
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
59 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
60 return name_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
61 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
62
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
63 void SetName(const std::string& name)
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
64 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
65 name_ = name;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
66 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
67
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
68 const std::string& GetUrl() const
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
69 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
70 return url_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
71 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
72
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
73 void SetUrl(const std::string& url)
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
74 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
75 url_ = url;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
76 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
77
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
78 const std::string& GetUsername() const
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
79 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
80 return username_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
81 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
82
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
83 void SetUsername(const std::string& username)
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
84 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
85 username_ = username;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
86 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
87
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
88 const std::string& GetPassword() const
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
89 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
90 return password_;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
91 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
92
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
93 void SetPassword(const std::string& password)
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
94 {
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
95 password_ = password;
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
96 }
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
97 };
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
98
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
99
62
a70bb32802ae renaming Server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 58
diff changeset
100 void OrthancInitialize(const char* configurationFile = NULL);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
62
a70bb32802ae renaming Server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 58
diff changeset
102 void OrthancFinalize();
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 std::string GetGlobalStringParameter(const std::string& parameter,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 const std::string& defaultValue);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 int GetGlobalIntegerParameter(const std::string& parameter,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 int defaultValue);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
23
62bd05fe4b7c support for ssl
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
110 bool GetGlobalBoolParameter(const std::string& parameter,
62bd05fe4b7c support for ssl
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
111 bool defaultValue);
62bd05fe4b7c support for ssl
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
112
806
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
113 void GetDicomModalityUsingSymbolicName(RemoteModalityParameters& modality,
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
114 const std::string& name);
617
a24b0161b171 lookup using aet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 613
diff changeset
115
806
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
116 bool LookupDicomModalityUsingAETitle(RemoteModalityParameters& modality,
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
117 const std::string& aet);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118
806
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
119 void GetOrthancPeer(OrthancPeerParameters& peer,
557575fd93e9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 773
diff changeset
120 const std::string& name);
484
b8ace6fc1d1f preparation for handling Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 429
diff changeset
121
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 void GetListOfDicomModalities(std::set<std::string>& target);
25
dd1489098265 basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 23
diff changeset
123
484
b8ace6fc1d1f preparation for handling Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 429
diff changeset
124 void GetListOfOrthancPeers(std::set<std::string>& target);
b8ace6fc1d1f preparation for handling Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 429
diff changeset
125
25
dd1489098265 basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 23
diff changeset
126 void SetupRegisteredUsers(MongooseServer& httpServer);
394
9784f19f7e1b path relative to configuration path, list of lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 270
diff changeset
127
429
09b3c6265a94 unit test for fedora 18 problem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 407
diff changeset
128 std::string InterpretRelativePath(const std::string& baseDirectory,
09b3c6265a94 unit test for fedora 18 problem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 407
diff changeset
129 const std::string& relativePath);
09b3c6265a94 unit test for fedora 18 problem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 407
diff changeset
130
394
9784f19f7e1b path relative to configuration path, list of lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 270
diff changeset
131 std::string InterpretStringParameterAsPath(const std::string& parameter);
9784f19f7e1b path relative to configuration path, list of lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 270
diff changeset
132
9784f19f7e1b path relative to configuration path, list of lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 270
diff changeset
133 void GetGlobalListOfStringsParameter(std::list<std::string>& target,
9784f19f7e1b path relative to configuration path, list of lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 270
diff changeset
134 const std::string& key);
613
60d90e48e809 query/retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 519
diff changeset
135
617
a24b0161b171 lookup using aet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 613
diff changeset
136 bool IsKnownAETitle(const std::string& aet);
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
137
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
138 bool IsSameAETitle(const std::string& aet1,
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
139 const std::string& aet2);
772
31cc399c7762 RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 771
diff changeset
140
31cc399c7762 RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 771
diff changeset
141 RemoteModalityParameters GetModalityUsingSymbolicName(const std::string& name);
31cc399c7762 RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 771
diff changeset
142
31cc399c7762 RemoteModalityParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 771
diff changeset
143 RemoteModalityParameters GetModalityUsingAet(const std::string& aet);
807
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
144
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
145 void UpdateModality(const RemoteModalityParameters& modality);
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
146
566a2fb3c1fb update/delete modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 806
diff changeset
147 void RemoveModality(const std::string& symbolicName);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 }