annotate Core/RestApi/RestApiPutCall.h @ 2518:63d2cc0fb40a

refactoring
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 29 Mar 2018 14:41:41 +0200
parents 878b59270859
children 4e43e67f8ecf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1571
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 975
diff changeset
4 * Department, University Hospital of Liege, Belgium
2447
878b59270859 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
83622b0f544c refactoring
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
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "RestApiCall.h"
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 namespace Orthanc
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class RestApiPutCall : public RestApiCall
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 private:
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
43 const char* bodyData_;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
44 size_t bodySize_;
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 public:
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 typedef void (*Handler) (RestApiPutCall& call);
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 RestApiPutCall(RestApiOutput& output,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 RestApi& context,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
51 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
52 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
53 const char* username,
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
54 const IHttpHandler::Arguments& httpHeaders,
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
55 const IHttpHandler::Arguments& uriComponents,
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const UriComponents& trailing,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 const UriComponents& fullUri,
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
58 const char* bodyData,
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
59 size_t bodySize) :
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
60 RestApiCall(output, context, origin, remoteIp, username,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
61 httpHeaders, uriComponents, trailing, fullUri),
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
62 bodyData_(bodyData),
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
63 bodySize_(bodySize)
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
67 const char* GetBodyData() const
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
68 {
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
69 return bodyData_;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
70 }
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
71
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
72 size_t GetBodySize() const
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 {
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
74 return bodySize_;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
75 }
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
76
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
77 void BodyToString(std::string& result) const
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
78 {
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
79 result.assign(bodyData_, bodySize_);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 virtual bool ParseJsonRequest(Json::Value& result) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 {
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
84 return ParseJsonRequestInternal(result, bodyData_);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 };
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }