bes  Updated for version 3.20.6
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 
51 typedef BESXMLCommand *(*p_xmlcmd_builder)(const BESDataHandlerInterface &dhi);
52 
63 class BESXMLCommand: public BESObj {
64 private:
66  static std::map<std::string, p_xmlcmd_builder> factory;
67  typedef std::map<std::string, p_xmlcmd_builder>::iterator cmd_iter;
68 
69 protected:
70  BESDataHandlerInterface d_xmlcmd_dhi;
71  virtual void set_response();
72 
74  std::string d_cmd_log_info;
75 
76  BESXMLCommand(const BESDataHandlerInterface &base_dhi);
77 
78 public:
79  virtual ~BESXMLCommand()
80  {
81  }
82 
88  virtual void parse_request(xmlNode *node) = 0;
89 
101  virtual bool has_response() = 0;
102 
107  virtual void prep_request()
108  {
109  }
110 
121  {
122  return d_xmlcmd_dhi;
123  }
124 
125  virtual void dump(std::ostream &strm) const;
126 
127  static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd);
128  static void del_command(const std::string &cmd_str);
129  static p_xmlcmd_builder find_command(const std::string &cmd_str);
130 };
131 
132 #endif // A_BESXMLCommand_h
133 
BESXMLCommand::BESXMLCommand
BESXMLCommand(const BESDataHandlerInterface &base_dhi)
Creates a BESXMLCommand document given a base data handler interface object.
Definition: BESXMLCommand.cc:55
BESXMLCommand::d_cmd_log_info
std::string d_cmd_log_info
Used only for the log.
Definition: BESXMLCommand.h:74
BESXMLCommand::set_response
virtual void set_response()
The request has been parsed, use the command action name to set the response handler.
Definition: BESXMLCommand.cc:63
BESXMLCommand::parse_request
virtual void parse_request(xmlNode *node)=0
Parse the XML request document beginning at the given node.
BESXMLCommand::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESXMLCommand.cc:119
BESXMLCommand::add_command
static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd)
Add a command to the possible commands allowed by this BES.
Definition: BESXMLCommand.cc:86
BESXMLCommand::get_xmlcmd_dhi
virtual BESDataHandlerInterface & get_xmlcmd_dhi()
Return the current BESDataHandlerInterface.
Definition: BESXMLCommand.h:120
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESXMLCommand
Base class for the BES's commands.
Definition: BESXMLCommand.h:63
BESXMLCommand::has_response
virtual bool has_response()=0
Does this command return a response to the client?
BESXMLCommand::find_command
static p_xmlcmd_builder find_command(const std::string &cmd_str)
Find the BESXMLCommand creation function with the given name.
Definition: BESXMLCommand.cc:108
BESXMLCommand::prep_request
virtual void prep_request()
Prepare any information needed to execute the request of this command.
Definition: BESXMLCommand.h:107
BESXMLCommand::del_command
static void del_command(const std::string &cmd_str)
Deletes the command called cmd_str from the list of possible commands.
Definition: BESXMLCommand.cc:96
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56