Mercurial > hg > orthanc
annotate Core/RestApi/RestApi.h @ 331:5a96dac27959
base class for rest calls made public
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 09 Jan 2013 11:48:51 +0100 |
parents | 78a8eaa5f30b |
children | c51c9ed603e6 |
rev | line source |
---|---|
209 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012 Medical Physics Department, CHU of Liege, | |
4 * Belgium | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU General Public License as | |
8 * published by the Free Software Foundation, either version 3 of the | |
9 * License, or (at your option) any later version. | |
10 * | |
11 * In addition, as a special exception, the copyright holders of this | |
12 * program give permission to link the code of its release with the | |
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
14 * that use the same license as the "OpenSSL" library), and distribute | |
15 * the linked executables. You must obey the GNU General Public License | |
16 * in all respects for all of the code used other than "OpenSSL". If you | |
17 * modify file(s) with this exception, you may extend this exception to | |
18 * your version of the file(s), but you are not obligated to do so. If | |
19 * you do not wish to do so, delete this exception statement from your | |
20 * version. If you delete this exception statement from all source files | |
21 * in the program, then also delete it here. | |
22 * | |
23 * This program is distributed in the hope that it will be useful, but | |
24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 * General Public License for more details. | |
27 * | |
28 * You should have received a copy of the GNU General Public License | |
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
30 **/ | |
31 | |
32 | |
33 #pragma once | |
34 | |
35 #include "../HttpServer/HttpHandler.h" | |
36 #include "RestApiPath.h" | |
37 #include "RestApiOutput.h" | |
38 | |
217 | 39 #include <list> |
40 | |
209 | 41 namespace Orthanc |
42 { | |
43 class RestApi : public HttpHandler | |
44 { | |
331
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
45 public: |
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
46 class Call |
209 | 47 { |
48 friend class RestApi; | |
49 | |
50 private: | |
51 RestApiOutput* output_; | |
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
52 RestApi* context_; |
209 | 53 const HttpHandler::Arguments* httpHeaders_; |
54 const RestApiPath::Components* uriComponents_; | |
55 const UriComponents* trailing_; | |
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
212
diff
changeset
|
56 const UriComponents* fullUri_; |
209 | 57 |
304 | 58 protected: |
59 static bool ParseJsonRequestInternal(Json::Value& result, | |
60 const char* request); | |
61 | |
209 | 62 public: |
63 RestApiOutput& GetOutput() | |
64 { | |
65 return *output_; | |
66 } | |
67 | |
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
68 RestApi& GetContext() |
209 | 69 { |
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
70 return *context_; |
209 | 71 } |
72 | |
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
212
diff
changeset
|
73 const UriComponents& GetFullUri() const |
209 | 74 { |
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
212
diff
changeset
|
75 return *fullUri_; |
209 | 76 } |
285
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
77 |
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
78 const UriComponents& GetTrailingUri() const |
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
79 { |
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
80 return *trailing_; |
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
81 } |
209 | 82 |
83 std::string GetUriComponent(const std::string& name, | |
231 | 84 const std::string& defaultValue) const |
209 | 85 { |
86 return HttpHandler::GetArgument(*uriComponents_, name, defaultValue); | |
87 } | |
212 | 88 |
89 std::string GetHttpHeader(const std::string& name, | |
231 | 90 const std::string& defaultValue) const |
212 | 91 { |
92 return HttpHandler::GetArgument(*httpHeaders_, name, defaultValue); | |
93 } | |
304 | 94 |
330 | 95 void ParseCookies(HttpHandler::Arguments& result) const |
96 { | |
97 HttpHandler::ParseCookies(result, *httpHeaders_); | |
98 } | |
99 | |
304 | 100 virtual bool ParseJsonRequest(Json::Value& result) const = 0; |
209 | 101 }; |
102 | |
103 | |
331
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
104 class GetCall : public Call |
209 | 105 { |
106 friend class RestApi; | |
107 | |
108 private: | |
109 const HttpHandler::Arguments* getArguments_; | |
110 | |
111 public: | |
112 std::string GetArgument(const std::string& name, | |
231 | 113 const std::string& defaultValue) const |
209 | 114 { |
115 return HttpHandler::GetArgument(*getArguments_, name, defaultValue); | |
116 } | |
237
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
231
diff
changeset
|
117 |
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
231
diff
changeset
|
118 bool HasArgument(const std::string& name) const |
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
231
diff
changeset
|
119 { |
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
231
diff
changeset
|
120 return getArguments_->find(name) != getArguments_->end(); |
16a4ac70bd8a
last change and export
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
231
diff
changeset
|
121 } |
304 | 122 |
123 virtual bool ParseJsonRequest(Json::Value& result) const; | |
209 | 124 }; |
125 | |
331
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
126 class PutCall : public Call |
209 | 127 { |
128 friend class RestApi; | |
129 | |
130 private: | |
131 const std::string* data_; | |
132 | |
133 public: | |
304 | 134 const std::string& GetPutBody() const |
209 | 135 { |
136 return *data_; | |
137 } | |
304 | 138 |
139 virtual bool ParseJsonRequest(Json::Value& result) const | |
140 { | |
141 return ParseJsonRequestInternal(result, GetPutBody().c_str()); | |
142 } | |
209 | 143 }; |
144 | |
331
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
145 class PostCall : public Call |
209 | 146 { |
147 friend class RestApi; | |
148 | |
149 private: | |
150 const std::string* data_; | |
151 | |
152 public: | |
304 | 153 const std::string& GetPostBody() const |
209 | 154 { |
155 return *data_; | |
156 } | |
304 | 157 |
158 virtual bool ParseJsonRequest(Json::Value& result) const | |
159 { | |
160 return ParseJsonRequestInternal(result, GetPostBody().c_str()); | |
161 } | |
209 | 162 }; |
163 | |
331
5a96dac27959
base class for rest calls made public
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
330
diff
changeset
|
164 class DeleteCall : public Call |
209 | 165 { |
304 | 166 public: |
167 virtual bool ParseJsonRequest(Json::Value& result) const | |
168 { | |
169 result.clear(); | |
170 return true; | |
171 } | |
209 | 172 }; |
173 | |
174 typedef void (*GetHandler) (GetCall& call); | |
175 | |
176 typedef void (*DeleteHandler) (DeleteCall& call); | |
177 | |
178 typedef void (*PutHandler) (PutCall& call); | |
179 | |
180 typedef void (*PostHandler) (PostCall& call); | |
181 | |
182 private: | |
183 typedef std::list< std::pair<RestApiPath*, GetHandler> > GetHandlers; | |
184 typedef std::list< std::pair<RestApiPath*, PutHandler> > PutHandlers; | |
185 typedef std::list< std::pair<RestApiPath*, PostHandler> > PostHandlers; | |
186 typedef std::list< std::pair<RestApiPath*, DeleteHandler> > DeleteHandlers; | |
187 | |
188 GetHandlers getHandlers_; | |
189 PutHandlers putHandlers_; | |
190 PostHandlers postHandlers_; | |
191 DeleteHandlers deleteHandlers_; | |
192 | |
193 bool IsGetAccepted(const UriComponents& uri); | |
194 bool IsPutAccepted(const UriComponents& uri); | |
195 bool IsPostAccepted(const UriComponents& uri); | |
196 bool IsDeleteAccepted(const UriComponents& uri); | |
197 | |
198 std::string GetAcceptedMethods(const UriComponents& uri); | |
199 | |
200 public: | |
201 RestApi() | |
202 { | |
203 } | |
204 | |
205 ~RestApi(); | |
206 | |
207 virtual bool IsServedUri(const UriComponents& uri); | |
208 | |
209 virtual void Handle(HttpOutput& output, | |
210 const std::string& method, | |
211 const UriComponents& uri, | |
212 const Arguments& headers, | |
213 const Arguments& getArguments, | |
214 const std::string& postData); | |
215 | |
216 void Register(const std::string& path, | |
217 GetHandler handler); | |
218 | |
219 void Register(const std::string& path, | |
220 PutHandler handler); | |
221 | |
222 void Register(const std::string& path, | |
223 PostHandler handler); | |
224 | |
225 void Register(const std::string& path, | |
226 DeleteHandler handler); | |
227 }; | |
228 } |