annotate OrthancServer/ServerJobs/OrthancPeerStoreJob.h @ 4026:05a363186da6

ORTHANC_BUILDING_FRAMEWORK_LIBRARY, Orthanc::InitializeFramework()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 09 Jun 2020 16:26:57 +0200
parents ef696db8426f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3095
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
36 #include "../../Core/Compatibility.h"
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "../../Core/JobsEngine/SetOfInstancesJob.h"
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include "../../Core/HttpClient.h"
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
43 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
44
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 class OrthancPeerStoreJob : public SetOfInstancesJob
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 private:
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
48 ServerContext& context_;
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
49 WebServiceParameters peer_;
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
50 std::unique_ptr<HttpClient> client_;
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
51 bool transcode_;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
52 DicomTransferSyntax transferSyntax_;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 protected:
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
55 virtual bool HandleInstance(const std::string& instance);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
57 virtual bool HandleTrailingStep();
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
58
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 public:
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 OrthancPeerStoreJob(ServerContext& context) :
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
61 context_(context),
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
62 transcode_(false)
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
66 OrthancPeerStoreJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
67 const Json::Value& serialize);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
68
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
69 void SetPeer(const WebServiceParameters& peer);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 const WebServiceParameters& GetPeer() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 return peer_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
76 bool IsTranscode() const
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
77 {
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
78 return transcode_;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
79 }
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
80
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
81 DicomTransferSyntax GetTransferSyntax() const;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
82
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
83 void SetTranscode(DicomTransferSyntax syntax);
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
84
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
85 void SetTranscode(const std::string& transferSyntaxUid);
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
86
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
87 void ClearTranscode();
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
88
2812
ea7aea6f6a95 improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2811
diff changeset
89 virtual void Stop(JobStopReason reason); // For pausing jobs
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 virtual void GetJobType(std::string& target)
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 target = "OrthancPeerStore";
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
96 virtual void GetPublicContent(Json::Value& value);
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
97
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
98 virtual bool Serialize(Json::Value& target);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 };
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 }