annotate OrthancFramework/Sources/RestApi/RestApiGetCall.h @ 4119:bf7b9edf6b81 framework-lgpl

re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 19:17:56 +0200
parents d25f4c0fa160
children 4d42408da117
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
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 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
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * the License, or (at your option) any later version.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
15 * Lesser General Public License for more details.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * <http://www.gnu.org/licenses/>.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "RestApiCall.h"
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 namespace Orthanc
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 class RestApiGetCall : public RestApiCall
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 private:
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
32 const IHttpHandler::Arguments& getArguments_;
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 public:
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 typedef void (*Handler) (RestApiGetCall& call);
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 RestApiGetCall(RestApiOutput& output,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 RestApi& context,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
39 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
40 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
41 const char* username,
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
42 const IHttpHandler::Arguments& httpHeaders,
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
43 const IHttpHandler::Arguments& uriComponents,
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 const UriComponents& trailing,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 const UriComponents& fullUri,
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
46 const IHttpHandler::Arguments& getArguments) :
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
47 RestApiCall(output, context, origin, remoteIp, username,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
48 httpHeaders, uriComponents, trailing, fullUri),
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 getArguments_(getArguments)
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 std::string GetArgument(const std::string& name,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 const std::string& defaultValue) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
56 return HttpToolbox::GetArgument(getArguments_, name, defaultValue);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 bool HasArgument(const std::string& name) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 return getArguments_.find(name) != getArguments_.end();
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 virtual bool ParseJsonRequest(Json::Value& result) const;
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 };
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 }