Mercurial > hg > orthanc
annotate OrthancServer/Plugins/Engine/PluginsJob.h @ 4805:0a38000b086d
Archive jobs response now contains a header Content-Disposition:filename='archive.zip'
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Tue, 09 Nov 2021 09:51:14 +0100 |
| parents | d9473bd5ed43 |
| children | 70d2a97ca8cb 7053502fbf97 |
| rev | line source |
|---|---|
| 2810 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
4437
d9473bd5ed43
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4204
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
| 2810 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #pragma once | |
| 35 | |
| 36 #if ORTHANC_ENABLE_PLUGINS == 1 | |
| 37 | |
|
4202
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4045
diff
changeset
|
38 #include "../../../OrthancFramework/Sources/Compatibility.h" // For ORTHANC_OVERRIDE |
| 4045 | 39 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" |
| 2810 | 40 #include "../Include/orthanc/OrthancCPlugin.h" |
| 41 | |
| 42 namespace Orthanc | |
| 43 { | |
| 44 class PluginsJob : public IJob | |
| 45 { | |
| 46 private: | |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
47 _OrthancPluginCreateJob parameters_; |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
48 std::string type_; |
| 2810 | 49 |
| 50 public: | |
| 4204 | 51 explicit PluginsJob(const _OrthancPluginCreateJob& parameters); |
| 2810 | 52 |
| 53 virtual ~PluginsJob(); | |
| 54 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
55 virtual void Start() ORTHANC_OVERRIDE |
| 2810 | 56 { |
| 57 } | |
| 58 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
59 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2810 | 60 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
61 virtual void Reset() ORTHANC_OVERRIDE; |
| 2810 | 62 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
63 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2810 | 64 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
65 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2810 | 66 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
67 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE |
| 2810 | 68 { |
| 69 target = type_; | |
| 70 } | |
| 71 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
72 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2810 | 73 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
74 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
75 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
76 virtual bool GetOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
77 MimeType& mime, |
|
4805
0a38000b086d
Archive jobs response now contains a header Content-Disposition:filename='archive.zip'
Alain Mazy <am@osimis.io>
parents:
4437
diff
changeset
|
78 std::string& filename, |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
79 const std::string& key) ORTHANC_OVERRIDE |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
80 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
81 // TODO |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
82 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
83 } |
| 2810 | 84 }; |
| 85 } | |
| 86 | |
| 87 #endif |