Mercurial > hg > orthanc-stone

annotate Framework/Toolbox/OrthancApiClient.h @ 309:14ef1227120f am-callable-and-promise

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
web services: better handling of failures
author am@osimis.io
date Fri, 28 Sep 2018 15:02:43 +0200
parents b4abaeb783b1
children aad37d0b6407
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
1 /**
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
2 * Stone of Orthanc
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
6 *
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
10 * the License, or (at your option) any later version.
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
11 *
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
15 * Affero General Public License for more details.
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
16 *
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
19 **/
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
20
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
21
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
22 #pragma once
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
23
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
24 #include <boost/shared_ptr.hpp>
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
25 #include <json/json.h>
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
26
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
27 #include "IWebService.h"
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
28 #include "../Messages/IObservable.h"
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
29 #include "../Messages/Promise.h"
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
30
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
31 namespace OrthancStone
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
32 {
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
33 class OrthancApiClient:
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
34 public IObservable
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
35 {
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
36 public:
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
37
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
38 struct JsonResponseReadyMessage : public BaseMessage<MessageType_OrthancApi_GenericGetJson_Ready>
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
39 {
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
40 Json::Value Response;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
41 std::string Uri;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
42 Orthanc::IDynamicObject* Payload;
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
43
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
44 JsonResponseReadyMessage(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
45 const Json::Value& response,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
46 Orthanc::IDynamicObject* payload = NULL)
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
47 : BaseMessage(),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
48 Response(response),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
49 Uri(uri),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
50 Payload(payload)
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
51 {
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
52 }
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
53 };
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
54
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
55 struct HttpErrorMessage : public BaseMessage<MessageType_OrthancApi_GenericHttpError_Ready>
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
56 {
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
57 std::string Uri;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
58 Orthanc::IDynamicObject* Payload;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
59
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
60 HttpErrorMessage(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
61 Orthanc::IDynamicObject* payload = NULL)
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
62 : BaseMessage(),
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
63 Uri(uri),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
64 Payload(payload)
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
65 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
66 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
67 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
68
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
69 struct BinaryResponseReadyMessage : public BaseMessage<MessageType_OrthancApi_GenericGetBinary_Ready>
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
70 {
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
71 const void* Answer;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
72 size_t AnswerSize;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
73 std::string Uri;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
74 Orthanc::IDynamicObject* Payload;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
75
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
76 BinaryResponseReadyMessage(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
77 const void* answer,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
78 size_t answerSize,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
79 Orthanc::IDynamicObject* payload = NULL)
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
80 : BaseMessage(),
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
81 Answer(answer),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
82 AnswerSize(answerSize),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
83 Uri(uri),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
84 Payload(payload)
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
85 {
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
86 }
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
87 };
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
88
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
89
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
90
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
91 public:
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
92
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
93 enum Mode
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
94 {
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
95 Mode_GetJson
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
96 };
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
97
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
98 protected:
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
99 IWebService& orthanc_;
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
100
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
101 public:
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
102 OrthancApiClient(MessageBroker& broker,
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
103 IWebService& orthanc);
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
104 virtual ~OrthancApiClient() {}
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
105
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
106 // schedule a GET request expecting a JSON response.
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
107 void GetJsonAsync(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
108 MessageHandler<JsonResponseReadyMessage>* successCallback,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
109 MessageHandler<HttpErrorMessage>* failureCallback = NULL,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
110 Orthanc::IDynamicObject* payload = NULL);
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
111
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
112 // schedule a GET request expecting a binary response.
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
113 void GetBinaryAsync(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
114 const std::string& contentType,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
115 MessageHandler<BinaryResponseReadyMessage>* successCallback,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
116 MessageHandler<HttpErrorMessage>* failureCallback = NULL,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
117 Orthanc::IDynamicObject* payload = NULL)
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
118 {
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
119 IWebService::Headers headers;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
120 headers["Accept"] = contentType;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
121 GetBinaryAsync(uri, headers, successCallback, failureCallback, payload);
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
122 }
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
123
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
124 // schedule a GET request expecting a binary response.
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
125 void GetBinaryAsync(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
126 const IWebService::Headers& headers,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
127 MessageHandler<BinaryResponseReadyMessage>* successCallback,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
128 MessageHandler<HttpErrorMessage>* failureCallback = NULL,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
129 Orthanc::IDynamicObject* payload = NULL);
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
130
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
131 // schedule a POST request expecting a JSON response.
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
132 void PostBinaryAsyncExpectJson(const std::string& uri,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
133 const std::string& body,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
134 MessageHandler<JsonResponseReadyMessage>* successCallback,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
135 MessageHandler<HttpErrorMessage>* failureCallback = NULL,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
136 Orthanc::IDynamicObject* payload = NULL);
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
137
309
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
138 // schedule a POST request expecting a JSON response.
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
139 void PostJsonAsyncExpectJson(const std::string& uri,
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
140 const Json::Value& data,
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
141 MessageHandler<JsonResponseReadyMessage>* successCallback,
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
142 MessageHandler<HttpErrorMessage>* failureCallback = NULL,
14ef1227120f web services: better handling of failures
am@osimis.io
parents: 300
diff changeset
143 Orthanc::IDynamicObject* payload = NULL);
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 271
diff changeset
144
270
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
145 };
2d64f4d39610 backup (work in progress)
am@osimis.io
parents:
diff changeset
146 }