Mercurial > hg > orthanc

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestApi.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents OrthancServer/OrthancRestApi/OrthancRestApi.h@7610af1532c3
children 05b8fd21089c
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "../../Core/DicomParsing/DicomModification.h"
37 #include "../../Core/JobsEngine/SetOfCommandsJob.h"
38 #include "../../Core/MetricsRegistry.h"
39 #include "../../Core/RestApi/RestApi.h"
40 #include "../ServerEnumerations.h"
41
42 #include <set>
43
44 namespace Orthanc
45 {
46 class ServerContext;
47 class ServerIndex;
48 class DicomInstanceToStore;
49
50 class OrthancRestApi : public RestApi
51 {
52 public:
53 typedef std::set<std::string> SetOfStrings;
54
55 private:
56 ServerContext& context_;
57 bool leaveBarrier_;
58 bool resetRequestReceived_;
59 MetricsRegistry::SharedMetrics activeRequests_;
60
61 void RegisterSystem();
62
63 void RegisterChanges();
64
65 void RegisterResources();
66
67 void RegisterModalities();
68
69 void RegisterAnonymizeModify();
70
71 void RegisterArchive();
72
73 static void ResetOrthanc(RestApiPostCall& call);
74
75 static void ShutdownOrthanc(RestApiPostCall& call);
76
77 public:
78 OrthancRestApi(ServerContext& context);
79
80 virtual bool Handle(HttpOutput& output,
81 RequestOrigin origin,
82 const char* remoteIp,
83 const char* username,
84 HttpMethod method,
85 const UriComponents& uri,
86 const Arguments& headers,
87 const GetArguments& getArguments,
88 const void* bodyData,
89 size_t bodySize) ORTHANC_OVERRIDE;
90
91 const bool& LeaveBarrierFlag() const
92 {
93 return leaveBarrier_;
94 }
95
96 bool IsResetRequestReceived() const
97 {
98 return resetRequestReceived_;
99 }
100
101 static OrthancRestApi& GetApi(RestApiCall& call)
102 {
103 return dynamic_cast<OrthancRestApi&>(call.GetContext());
104 }
105
106 static ServerContext& GetContext(RestApiCall& call);
107
108 static ServerIndex& GetIndex(RestApiCall& call);
109
110 // WARNING: "instanceId" can be different from
111 // "instance.GetHasher().HashInstance()" if transcoding is enabled
112 void AnswerStoredInstance(RestApiPostCall& call,
113 DicomInstanceToStore& instance,
114 StoreStatus status,
115 const std::string& instanceId) const;
116
117 void AnswerStoredResource(RestApiPostCall& call,
118 const std::string& publicId,
119 ResourceType resourceType,
120 StoreStatus status) const;
121
122 static bool IsSynchronousJobRequest(bool isDefaultSynchronous,
123 const Json::Value& body);
124
125 static unsigned int GetJobRequestPriority(const Json::Value& body);
126
127 static void SubmitGenericJob(RestApiOutput& output,
128 ServerContext& context,
129 IJob* job,
130 bool synchronous,
131 int priority);
132
133 void SubmitGenericJob(RestApiPostCall& call,
134 IJob* job,
135 bool isDefaultSynchronous,
136 const Json::Value& body) const;
137
138 void SubmitCommandsJob(RestApiPostCall& call,
139 SetOfCommandsJob* job,
140 bool isDefaultSynchronous,
141 const Json::Value& body) const;
142 };
143 }