Mercurial > hg > orthanc

annotate OrthancFramework/Sources/RestApi/RestApiGetCall.h @ 5640:f7adfb22e20e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated copyright, as Orthanc Team now replaces Osimis
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 30 May 2024 21:19:57 +0200
parents 48b8dae6dc77
children
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
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * 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
10 * 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
11 * 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
12 * the License, or (at your option) any later version.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * 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
17 * Lesser General Public License for more details.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
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
19 * 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
20 * 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
21 * <http://www.gnu.org/licenses/>.
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 **/
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #pragma once
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include "RestApiCall.h"
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace Orthanc
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 class RestApiGetCall : public RestApiCall
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 private:
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4203
diff changeset
34 const HttpToolbox::Arguments& getArguments_;
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 public:
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 typedef void (*Handler) (RestApiGetCall& call);
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 RestApiGetCall(RestApiOutput& output,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 RestApi& context,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
41 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
42 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
43 const char* username,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4203
diff changeset
44 const HttpToolbox::Arguments& httpHeaders,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4203
diff changeset
45 const HttpToolbox::Arguments& uriComponents,
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 const UriComponents& trailing,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 const UriComponents& fullUri,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4203
diff changeset
48 const HttpToolbox::Arguments& getArguments) :
4399
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
49 RestApiCall(output, context, origin, remoteIp, username, HttpMethod_Get,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1441
diff changeset
50 httpHeaders, uriComponents, trailing, fullUri),
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 getArguments_(getArguments)
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 std::string GetArgument(const std::string& name,
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const std::string& defaultValue) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 {
1441
f3672356c121 refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
58 return HttpToolbox::GetArgument(getArguments_, name, defaultValue);
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 }
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 bool HasArgument(const std::string& name) const
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 return getArguments_.find(name) != getArguments_.end();
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 }
4834
bec432ee1094 download of numpy arrays from the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
65
bec432ee1094 download of numpy arrays from the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
66 bool GetBooleanArgument(const std::string& name,
bec432ee1094 download of numpy arrays from the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
67 bool defaultValue) const;
4401
354ea95b294a documenting system calls
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4399
diff changeset
68
4203
4d42408da117 improving const-correctness in ParsedDicomFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
69 virtual bool ParseJsonRequest(Json::Value& result) const ORTHANC_OVERRIDE;
974
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 };
83622b0f544c refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 }