Mercurial > hg > orthanc
annotate Core/RestApi/RestApi.h @ 210:96b7918a6a18
start of the refactoring of the Orthanc REST API
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 28 Nov 2012 18:03:44 +0100 |
| parents | 9960642f0f45 |
| children | f276b175dcaf |
| rev | line source |
|---|---|
| 209 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012 Medical Physics Department, CHU of Liege, | |
| 4 * Belgium | |
| 5 * | |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 10 * | |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 22 * | |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 #pragma once | |
| 34 | |
| 35 #include "../HttpServer/HttpHandler.h" | |
| 36 #include "RestApiPath.h" | |
| 37 #include "RestApiOutput.h" | |
| 38 | |
| 39 namespace Orthanc | |
| 40 { | |
| 41 class RestApi : public HttpHandler | |
| 42 { | |
| 43 private: | |
| 44 class SharedCall | |
| 45 { | |
| 46 friend class RestApi; | |
| 47 | |
| 48 private: | |
| 49 RestApiOutput* output_; | |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
50 RestApi* context_; |
| 209 | 51 const HttpHandler::Arguments* httpHeaders_; |
| 52 const RestApiPath::Components* uriComponents_; | |
| 53 const UriComponents* trailing_; | |
| 54 | |
| 55 public: | |
| 56 RestApiOutput& GetOutput() | |
| 57 { | |
| 58 return *output_; | |
| 59 } | |
| 60 | |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
61 RestApi& GetContext() |
| 209 | 62 { |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
63 return *context_; |
| 209 | 64 } |
| 65 | |
| 66 const HttpHandler::Arguments& GetHttpHeaders() const | |
| 67 { | |
| 68 return *httpHeaders_; | |
| 69 } | |
| 70 | |
| 71 const RestApiPath::Components& GetUriComponents() const | |
| 72 { | |
| 73 return *uriComponents_; | |
| 74 } | |
| 75 | |
| 76 const UriComponents& GetTrailing() const | |
| 77 { | |
| 78 return *trailing_; | |
| 79 } | |
| 80 | |
| 81 std::string GetUriComponent(const std::string& name, | |
| 82 const std::string& defaultValue) | |
| 83 { | |
| 84 return HttpHandler::GetArgument(*uriComponents_, name, defaultValue); | |
| 85 } | |
| 86 }; | |
| 87 | |
| 88 | |
| 89 public: | |
| 90 class GetCall : public SharedCall | |
| 91 { | |
| 92 friend class RestApi; | |
| 93 | |
| 94 private: | |
| 95 const HttpHandler::Arguments* getArguments_; | |
| 96 | |
| 97 public: | |
| 98 std::string GetArgument(const std::string& name, | |
| 99 const std::string& defaultValue) | |
| 100 { | |
| 101 return HttpHandler::GetArgument(*getArguments_, name, defaultValue); | |
| 102 } | |
| 103 }; | |
| 104 | |
| 105 class PutCall : public SharedCall | |
| 106 { | |
| 107 friend class RestApi; | |
| 108 | |
| 109 private: | |
| 110 const std::string* data_; | |
| 111 | |
| 112 public: | |
| 113 const std::string& GetData() | |
| 114 { | |
| 115 return *data_; | |
| 116 } | |
| 117 }; | |
| 118 | |
| 119 class PostCall : public SharedCall | |
| 120 { | |
| 121 friend class RestApi; | |
| 122 | |
| 123 private: | |
| 124 const std::string* data_; | |
| 125 | |
| 126 public: | |
| 127 const std::string& GetData() | |
| 128 { | |
| 129 return *data_; | |
| 130 } | |
| 131 }; | |
| 132 | |
| 133 class DeleteCall : public SharedCall | |
| 134 { | |
| 135 }; | |
| 136 | |
| 137 typedef void (*GetHandler) (GetCall& call); | |
| 138 | |
| 139 typedef void (*DeleteHandler) (DeleteCall& call); | |
| 140 | |
| 141 typedef void (*PutHandler) (PutCall& call); | |
| 142 | |
| 143 typedef void (*PostHandler) (PostCall& call); | |
| 144 | |
| 145 private: | |
| 146 typedef std::list< std::pair<RestApiPath*, GetHandler> > GetHandlers; | |
| 147 typedef std::list< std::pair<RestApiPath*, PutHandler> > PutHandlers; | |
| 148 typedef std::list< std::pair<RestApiPath*, PostHandler> > PostHandlers; | |
| 149 typedef std::list< std::pair<RestApiPath*, DeleteHandler> > DeleteHandlers; | |
| 150 | |
| 151 GetHandlers getHandlers_; | |
| 152 PutHandlers putHandlers_; | |
| 153 PostHandlers postHandlers_; | |
| 154 DeleteHandlers deleteHandlers_; | |
| 155 | |
| 156 bool IsGetAccepted(const UriComponents& uri); | |
| 157 bool IsPutAccepted(const UriComponents& uri); | |
| 158 bool IsPostAccepted(const UriComponents& uri); | |
| 159 bool IsDeleteAccepted(const UriComponents& uri); | |
| 160 | |
| 161 std::string GetAcceptedMethods(const UriComponents& uri); | |
| 162 | |
| 163 public: | |
| 164 RestApi() | |
| 165 { | |
| 166 } | |
| 167 | |
| 168 ~RestApi(); | |
| 169 | |
| 170 virtual bool IsServedUri(const UriComponents& uri); | |
| 171 | |
| 172 virtual void Handle(HttpOutput& output, | |
| 173 const std::string& method, | |
| 174 const UriComponents& uri, | |
| 175 const Arguments& headers, | |
| 176 const Arguments& getArguments, | |
| 177 const std::string& postData); | |
| 178 | |
| 179 void Register(const std::string& path, | |
| 180 GetHandler handler); | |
| 181 | |
| 182 void Register(const std::string& path, | |
| 183 PutHandler handler); | |
| 184 | |
| 185 void Register(const std::string& path, | |
| 186 PostHandler handler); | |
| 187 | |
| 188 void Register(const std::string& path, | |
| 189 DeleteHandler handler); | |
| 190 }; | |
| 191 } |