bes  Updated for version 3.19.1
BESXMLCommand.h
1 // BESXMLCommand.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef A_BESXMLCommand_h
34 #define A_BESXMLCommand_h 1
35 
36 #include <string>
37 #include <map>
38 
39 #include <libxml/encoding.h>
40 
41 #include "BESObj.h"
42 #include "BESDataHandlerInterface.h"
43 
44 //class BESResponseHandler;
45 class BESXMLCommand;
46 
47 // p_xmlcmd_builder: a pointer to a function that takes a BESDataHandlerInterface
48 // instance and returns a BESXMLCommand instance.
49 typedef BESXMLCommand *(*p_xmlcmd_builder)(const BESDataHandlerInterface &dhi);
50 
51 class BESXMLCommand: public BESObj {
52 private:
54  static std::map<std::string, p_xmlcmd_builder> cmd_list;
55  typedef std::map<std::string, p_xmlcmd_builder>::iterator cmd_iter;
56 
57 protected:
58  BESDataHandlerInterface d_xmlcmd_dhi;
59  virtual void set_response();
60 
62  std::string d_cmd_log_info;
63 
64  BESXMLCommand(const BESDataHandlerInterface &base_dhi);
65 
66 public:
67  virtual ~BESXMLCommand()
68  {
69  }
70 
76  virtual void parse_request(xmlNode *node) = 0;
77 
84  virtual bool has_response() = 0;
85 
90  virtual void prep_request()
91  {
92  }
93 
104  {
105  return d_xmlcmd_dhi;
106  }
107 
108  virtual void dump(ostream &strm) const;
109 
110  static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd);
111  static bool del_command(const std::string &cmd_str);
112  static p_xmlcmd_builder find_command(const std::string &cmd_str);
113 };
114 
115 #endif // A_BESXMLCommand_h
116 
BESXMLCommand(const BESDataHandlerInterface &base_dhi)
Creates a BESXMLCommand document given a base data handler interface object.
virtual void dump(ostream &strm) const
dumps information about this object
virtual void parse_request(xmlNode *node)=0
Parse the XML request document beginning at the given node.
Base object for bes objects.
Definition: BESObj.h:52
virtual void set_response()
The request has been parsed, use the command action name to set the response handler.
static p_xmlcmd_builder find_command(const std::string &cmd_str)
Find the BESXMLCommand creation function with the given name.
virtual void prep_request()
Prepare any information needed to execute the request of this command.
Definition: BESXMLCommand.h:90
static bool del_command(const std::string &cmd_str)
Deletes the command called cmd_str from the list of possible commands.
Structure storing information used by the BES to handle the request.
static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd)
Add a command to the possible commands allowed by this BES.
virtual BESDataHandlerInterface & get_xmlcmd_dhi()
Return the current BESDataHandlerInterface.
virtual bool has_response()=0
Has a response handler been created given the request document?
std::string d_cmd_log_info
Used only for the log.
Definition: BESXMLCommand.h:62