annotate Platforms/Generic/WebServiceCommandBase.h @ 976:3abc47e051c8

Added tag toa2019083101 for changeset e75fd08d6c75
author Benjamin Golinvaux <bgo@osimis.io>
date Sat, 31 Aug 2019 13:50:11 +0200
parents 861c080ef47b
children e713f1a99861 2d8ab34c8c91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
1 /**
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
2 * Stone of Orthanc
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
439
b70e9be013e4 preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 417
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
6 *
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
10 * the License, or (at your option) any later version.
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
11 *
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
15 * Affero General Public License for more details.
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
16 *
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
19 **/
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
20
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
21
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
22 #pragma once
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
23
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
24 #include "IOracleCommand.h"
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
25
732
c35e98d22764 move Deprecated classes to a separate folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 726
diff changeset
26 #include "../../Framework/Deprecated/Toolbox/IWebService.h"
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
27 #include "../../Framework/Messages/IObservable.h"
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
28 #include "../../Framework/Messages/ICallable.h"
291
87376a645ee1 renaming
am@osimis.io
parents: 274
diff changeset
29 #include "../../Applications/Generic/NativeStoneApplicationContext.h"
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
30
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
31 #include <Core/WebServiceParameters.h>
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
32
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
33 #include <memory>
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
34
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
35 namespace Deprecated
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
36 {
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
37 class WebServiceCommandBase : public IOracleCommand, OrthancStone::IObservable
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
38 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
39 protected:
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
40 std::auto_ptr<OrthancStone::MessageHandler<IWebService::HttpRequestSuccessMessage> > successCallback_;
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
41 std::auto_ptr<OrthancStone::MessageHandler<IWebService::HttpRequestErrorMessage> > failureCallback_;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
42 Orthanc::WebServiceParameters parameters_;
417
aee3d7941c9b preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 334
diff changeset
43 std::string url_;
aee3d7941c9b preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 334
diff changeset
44 IWebService::HttpHeaders headers_;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
45 std::auto_ptr<Orthanc::IDynamicObject> payload_;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
46 bool success_;
940
861c080ef47b handling httpStatus in WebService error messages
Alain Mazy <alain@mazy.be>
parents: 732
diff changeset
47 Orthanc::HttpStatus httpStatus_;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
48 std::string answer_;
417
aee3d7941c9b preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 334
diff changeset
49 IWebService::HttpHeaders answerHeaders_;
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
50 OrthancStone::NativeStoneApplicationContext& context_;
309
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 301
diff changeset
51 unsigned int timeoutInSeconds_;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
52
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
53 public:
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
54 WebServiceCommandBase(OrthancStone::MessageBroker& broker,
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
55 OrthancStone::MessageHandler<IWebService::HttpRequestSuccessMessage>* successCallback, // takes ownership
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
56 OrthancStone::MessageHandler<IWebService::HttpRequestErrorMessage>* failureCallback, // takes ownership
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
57 const Orthanc::WebServiceParameters& parameters,
417
aee3d7941c9b preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 334
diff changeset
58 const std::string& url,
aee3d7941c9b preparing to load images using DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 334
diff changeset
59 const IWebService::HttpHeaders& headers,
309
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 301
diff changeset
60 unsigned int timeoutInSeconds,
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
61 Orthanc::IDynamicObject* payload /* takes ownership */,
726
4f2416d519b4 moving layers, widgets and loaders to Deprecated namespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 439
diff changeset
62 OrthancStone::NativeStoneApplicationContext& context
309
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 301
diff changeset
63 );
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
64
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
65 virtual void Execute() = 0;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
66
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
67 virtual void Commit();
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
68 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 291
diff changeset
69
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents:
diff changeset
70 }