OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLCommand.h
Go to the documentation of this file.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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"
46 
47 class BESResponseHandler ;
48 class BESXMLCommand ;
49 typedef BESXMLCommand *(*p_xmlcmd_builder)( const BESDataHandlerInterface &dhi);
50 
51 class BESXMLCommand : public BESObj
52 {
53 private:
54  static map< string, p_xmlcmd_builder > cmd_list ;
55  typedef map< string, p_xmlcmd_builder >::iterator cmd_iter ;
56 protected:
58  virtual void set_response() ;
59  string _str_cmd ;
60  BESXMLCommand( const BESDataHandlerInterface &base_dhi ) ;
61 public:
62  virtual ~BESXMLCommand() {}
63 
68  virtual void parse_request( xmlNode *node ) = 0 ;
74  virtual bool has_response() = 0 ;
78  virtual void prep_request() {}
87  virtual BESDataHandlerInterface &get_dhi() { return _dhi ; }
88 
89  virtual void dump( ostream &strm ) const ;
90 
91  static void add_command( const string &cmd_str,
92  p_xmlcmd_builder cmd ) ;
93  static bool del_command( const string &cmd_str ) ;
94  static p_xmlcmd_builder find_command( const string &cmd_str ) ;
95 } ;
96 
97 #endif // A_BESXMLCommand_h
98 
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 dump(ostream &strm) const
dumps information about this object
BESXMLCommand *(* p_xmlcmd_builder)(const BESDataHandlerInterface &dhi)
Definition: BESXMLCommand.h:49
virtual ~BESXMLCommand()
Definition: BESXMLCommand.h:62
BESDataHandlerInterface _dhi
Definition: BESXMLCommand.h:57
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:87
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:78
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?
static p_xmlcmd_builder find_command(const string &cmd_str)
Find the BESXMLCommand creation function with the given name.