bes  Updated for version 3.17.0
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 using std::string;
40 using std::map;
41 
42 #include <libxml/encoding.h>
43 
44 #include "BESObj.h"
45 #include "BESDataHandlerInterface.h"
46 
47 class BESResponseHandler;
48 class BESXMLCommand;
49 typedef BESXMLCommand *(*p_xmlcmd_builder)(const BESDataHandlerInterface &dhi);
50 
51 class BESXMLCommand: public BESObj {
52 private:
53  static map<string, p_xmlcmd_builder> cmd_list;
54  typedef map<string, p_xmlcmd_builder>::iterator cmd_iter;
55 protected:
57  virtual void set_response();
58  // The _str_cmd is used only for the log
59  string _str_cmd;
60  BESXMLCommand(const BESDataHandlerInterface &base_dhi);
61 public:
62  virtual ~BESXMLCommand()
63  {
64  }
65 
70  virtual void parse_request(xmlNode *node) = 0;
76  virtual bool has_response() = 0;
80  virtual void prep_request()
81  {
82  }
92  {
93  return _dhi;
94  }
95 
96  virtual void dump(ostream &strm) const;
97 
98  static void add_command(const string &cmd_str, p_xmlcmd_builder cmd);
99  static bool del_command(const string &cmd_str);
100  static p_xmlcmd_builder find_command(const string &cmd_str);
101 };
102 
103 #endif // A_BESXMLCommand_h
104 
BESXMLCommand(const BESDataHandlerInterface &base_dhi)
Creates a BESXMLCommand document given a base data handler interface object.
static bool del_command(const string &cmd_str)
Deletes the command called cmd_str from the list of possible commands.
static void add_command(const string &cmd_str, p_xmlcmd_builder cmd)
Add a command to the possible commands allowed by this BES.
virtual void parse_request(xmlNode *node)=0
Parse the XML request document begining at the given node.
virtual BESDataHandlerInterface & get_dhi()
Return the current BESDataHandlerInterface.
Definition: BESXMLCommand.h:91
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.
handler object that knows how to create a specific response object
virtual void prep_request()
Prepare any information needed to execute the request of this command.
Definition: BESXMLCommand.h:80
Structure storing information used by the BES to handle the request.
virtual bool has_response()=0
Has a response handler been created given the request document?
virtual void dump(ostream &strm) const
dumps information about this object
static p_xmlcmd_builder find_command(const string &cmd_str)
Find the BESXMLCommand creation function with the given name.