Mercurial > hg > orthanc
annotate Core/RestApi/RestApiOutput.h @ 2243:2dbfdafc2512
Logger compatible with the Orthanc plugin SDK
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 23 Dec 2016 16:02:00 +0100 |
| parents | b1291df2f780 |
| children | a3a65de1840f |
| rev | line source |
|---|---|
| 209 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1113
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 209 | 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/HttpOutput.h" | |
| 36 #include "../HttpServer/HttpFileSender.h" | |
| 37 | |
| 38 #include <json/json.h> | |
| 39 | |
| 40 namespace Orthanc | |
| 41 { | |
| 42 class RestApiOutput | |
| 43 { | |
| 44 private: | |
|
1514
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
45 HttpOutput& output_; |
|
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
46 HttpMethod method_; |
|
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
47 bool alreadySent_; |
|
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
48 bool convertJsonToXml_; |
| 209 | 49 |
| 211 | 50 void CheckStatus(); |
| 51 | |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
52 void SignalErrorInternal(HttpStatus status, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
53 const char* message, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
54 size_t messageSize); |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
55 |
| 209 | 56 public: |
| 1368 | 57 RestApiOutput(HttpOutput& output, |
| 58 HttpMethod method); | |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
59 |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
60 ~RestApiOutput(); |
| 209 | 61 |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
62 void SetConvertJsonToXml(bool convert) |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
63 { |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
64 convertJsonToXml_ = convert; |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
65 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
66 |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
67 bool IsConvertJsonToXml() const |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
68 { |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
69 return convertJsonToXml_; |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
70 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
71 |
|
1519
8bd0d897763f
refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1518
diff
changeset
|
72 void AnswerStream(IHttpStreamAnswer& stream); |
| 209 | 73 |
| 74 void AnswerJson(const Json::Value& value); | |
| 75 | |
| 76 void AnswerBuffer(const std::string& buffer, | |
| 77 const std::string& contentType); | |
| 78 | |
| 339 | 79 void AnswerBuffer(const void* buffer, |
| 80 size_t length, | |
| 81 const std::string& contentType); | |
| 82 | |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
83 void SignalError(HttpStatus status); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
84 |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
85 void SignalError(HttpStatus status, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
86 const std::string& message); |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1519
diff
changeset
|
87 |
|
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
211
diff
changeset
|
88 void Redirect(const std::string& path); |
| 330 | 89 |
| 90 void SetCookie(const std::string& name, | |
| 91 const std::string& value, | |
| 92 unsigned int maxAge = 0); | |
| 93 | |
| 94 void ResetCookie(const std::string& name); | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1046
diff
changeset
|
95 |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1046
diff
changeset
|
96 void Finalize(); |
| 209 | 97 }; |
| 98 } |