annotate Framework/Toolbox/IWebService.h @ 269:0dfa83535cd7 am-2

indentation
author am@osimis.io
date Wed, 22 Aug 2018 15:22:33 +0200
parents 5bd4161bf11b
children 8c8da145fefa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
135
e2fe9352f240 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 113
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
16 *
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
212
5412adf19980 resort to OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 201
diff changeset
24 #include <Core/IDynamicObject.h>
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
25 #include "../../Framework/Messages/IObserver.h"
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <string>
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
27 #include <Core/Logging.h>
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
31 class IWebService
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
32 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
33 protected:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
34 MessageBroker& broker_;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
35 public:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
36 typedef std::map<std::string, std::string> Headers;
257
9afafb192180 using PAM
am@osimis.io
parents: 252
diff changeset
37
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
38 class ICallback : public IObserver
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
39 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
40 public:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
41 struct HttpRequestSuccessMessage: public IMessage
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
42 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
43 const std::string& Uri;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
44 const void* Answer;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
45 size_t AnswerSize;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
46 Orthanc::IDynamicObject* Payload;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
47 HttpRequestSuccessMessage(const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
48 const void* answer,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
49 size_t answerSize,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
50 Orthanc::IDynamicObject* payload)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
51 : IMessage(MessageType_HttpRequestSuccess),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
52 Uri(uri),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
53 Answer(answer),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
54 AnswerSize(answerSize),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
55 Payload(payload)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
56 {}
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
57 };
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
59 struct HttpRequestErrorMessage: public IMessage
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
60 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
61 const std::string& Uri;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
62 Orthanc::IDynamicObject* Payload;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
63 HttpRequestErrorMessage(const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
64 Orthanc::IDynamicObject* payload)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
65 : IMessage(MessageType_HttpRequestError),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
66 Uri(uri),
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
67 Payload(payload)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
68 {}
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
69 };
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
70
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
71 ICallback(MessageBroker& broker)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
72 : IObserver(broker)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
73 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
74 DeclareHandledMessage(MessageType_HttpRequestError);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
75 DeclareHandledMessage(MessageType_HttpRequestSuccess);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
76 }
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
77 virtual ~ICallback()
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
78 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
79 }
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
81 virtual void HandleMessage(IObservable& from, const IMessage& message)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
82 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
83 switch(message.GetType())
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
84 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
85 case MessageType_HttpRequestError:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
86 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
87 const HttpRequestErrorMessage& msg = dynamic_cast<const HttpRequestErrorMessage&>(message);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
88 OnHttpRequestError(msg.Uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
89 msg.Payload);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
90 }; break;
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
91
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
92 case MessageType_HttpRequestSuccess:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
93 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
94 const HttpRequestSuccessMessage& msg = dynamic_cast<const HttpRequestSuccessMessage&>(message);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
95 OnHttpRequestSuccess(msg.Uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
96 msg.Answer,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
97 msg.AnswerSize,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
98 msg.Payload);
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
99 }; break;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
100 default:
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
101 VLOG("unhandled message type" << message.GetType());
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
102 }
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
103 }
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
104
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
105 virtual void OnHttpRequestError(const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
106 Orthanc::IDynamicObject* payload) = 0;
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
108 virtual void OnHttpRequestSuccess(const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
109 const void* answer,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
110 size_t answerSize,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
111 Orthanc::IDynamicObject* payload) = 0;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
112 };
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
113
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
114 IWebService(MessageBroker& broker)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
115 : broker_(broker)
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
116 {}
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
118 virtual ~IWebService()
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
119 {
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
120 }
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
121
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
122 virtual void ScheduleGetRequest(ICallback& callback,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
123 const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
124 const Headers& headers,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
125 Orthanc::IDynamicObject* payload) = 0;
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 212
diff changeset
126
269
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
127 virtual void SchedulePostRequest(ICallback& callback,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
128 const std::string& uri,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
129 const Headers& headers,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
130 const std::string& body,
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
131 Orthanc::IDynamicObject* payload) = 0;
0dfa83535cd7 indentation
am@osimis.io
parents: 268
diff changeset
132 };
57
d20e25cfcf3a IWebService
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }