1 /* <!-- copyright */ 2 /* 3 * aria2 - The high speed download utility 4 * 5 * Copyright (C) 2009 Tatsuhiro Tsujikawa 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 * 21 * In addition, as a special exception, the copyright holders give 22 * permission to link the code of portions of this program with the 23 * OpenSSL library under certain conditions as described in each 24 * individual source file, and distribute linked combinations 25 * including the two. 26 * You must obey the GNU General Public License in all respects 27 * for all of the code used other than OpenSSL. If you modify 28 * file(s) with this exception, you may extend this exception to your 29 * version of the file(s), but you are not obligated to do so. If you 30 * do not wish to do so, delete this exception statement from your 31 * version. If you delete this exception statement from all source 32 * files in the program, then also delete it here. 33 */ 34 /* copyright --> */ 35 #ifndef D_RPC_METHOD_H 36 #define D_RPC_METHOD_H 37 38 #include "common.h" 39 40 #include <string> 41 #include <memory> 42 43 #include "ValueBase.h" 44 45 namespace aria2 { 46 47 class DownloadEngine; 48 class OptionParser; 49 class Option; 50 class Exception; 51 52 namespace rpc { 53 54 struct RpcRequest; 55 struct RpcResponse; 56 57 // This class offers abstract implementation of processing RPC 58 // request. You have to inherit this class and implement process() 59 // method to add new RPC API. The derived class must be stateless 60 // since we reuse the instances. 61 // 62 // There is RpcMethodFactory class which instantiates RpcMethod 63 // subclass. If you add new RpcMethod subclass, don't forget to add it 64 // to RpcMethodFactory. 65 class RpcMethod { 66 private: 67 std::shared_ptr<OptionParser> optionParser_; 68 69 protected: 70 // Subclass must implement this function to fulfil RpcRequest req. 71 // The return value of this method is used as a return value of RPC 72 // request. 73 virtual std::unique_ptr<ValueBase> process(const RpcRequest& req, 74 DownloadEngine* e) = 0; 75 76 void gatherRequestOption(Option* option, const Dict* optionsDict); 77 78 void gatherChangeableOption(Option* option, Option* pendingOption, 79 const Dict* optionDict); 80 81 void gatherChangeableOptionForReserved(Option* option, 82 const Dict* optionsDict); 83 84 void gatherChangeableGlobalOption(Option* option, const Dict* optionDict); 85 86 std::unique_ptr<ValueBase> createErrorResponse(const Exception& e, 87 const RpcRequest& req); 88 getOptionParser()89 const std::shared_ptr<OptionParser>& getOptionParser() const 90 { 91 return optionParser_; 92 } 93 94 public: 95 RpcMethod(); 96 97 virtual ~RpcMethod(); 98 99 virtual void authorize(RpcRequest& req, DownloadEngine* e); 100 101 // Do work to fulfill RpcRequest req and returns its result as 102 // RpcResponse. This method delegates to process() method. 103 virtual RpcResponse execute(RpcRequest req, DownloadEngine* e); 104 }; 105 106 } // namespace rpc 107 108 } // namespace aria2 109 110 #endif // D_RPC_METHOD_H 111