XmlRpcMethod.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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_XML_RPC_METHOD_H_
  36. #define _D_XML_RPC_METHOD_H_
  37. #include "common.h"
  38. #include <string>
  39. #include "SharedHandle.h"
  40. namespace aria2 {
  41. class DownloadEngine;
  42. class OptionParser;
  43. class BDE;
  44. class Logger;
  45. class Option;
  46. class Exception;
  47. namespace xmlrpc {
  48. struct XmlRpcRequest;
  49. struct XmlRpcResponse;
  50. // This class offers abstract implementation of processing XML-RPC
  51. // request. You have to inherit this class and implement process()
  52. // method to add new XML-RPC API.
  53. //
  54. // There is XmlRpcMethodFactory class which instantiates XmlRpcMethod
  55. // subclass. If you add new XmlRpcMethod subclass, don't forget to add
  56. // it to XmlRpcMethodFactory.
  57. class XmlRpcMethod {
  58. protected:
  59. SharedHandle<OptionParser> _optionParser;
  60. Logger* _logger;
  61. // Subclass must implement this function to fulfil XmlRpcRequest
  62. // req. The return value of this method is used as a return value
  63. // of XML-RPC request.
  64. virtual BDE process(const XmlRpcRequest& req, DownloadEngine* e) = 0;
  65. void gatherRequestOption(const SharedHandle<Option>& option,
  66. const BDE& optionsDict);
  67. void gatherChangeableOption(const SharedHandle<Option>& option,
  68. const BDE& optionDict);
  69. // Copy options which is changeable in XML-RPC changeOption command
  70. // to dest.
  71. void applyChangeableOption(Option* dest, Option* src) const;
  72. void gatherChangeableGlobalOption(const SharedHandle<Option>& option,
  73. const BDE& optionDict);
  74. // Copy options which is changeable in XML-RPC changeGlobalOption
  75. // command to dest.
  76. void applyChangeableGlobalOption(Option* dest, Option* src) const;
  77. BDE createErrorResponse(const Exception& e);
  78. public:
  79. XmlRpcMethod();
  80. virtual ~XmlRpcMethod() {}
  81. // Do work to fulfill XmlRpcRequest req and returns its result as
  82. // XmlRpcResponse. This method delegates to process() method.
  83. XmlRpcResponse execute(const XmlRpcRequest& req, DownloadEngine* e);
  84. };
  85. } // namespace xmlrpc
  86. } // namespace aria2
  87. #endif // _D_XML_RPC_METHOD_H_