bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
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#include <libxml/tree.h>
41
42#include "BESObj.h"
43#include "BESDataHandlerInterface.h"
44
45//class BESResponseHandler;
46class BESXMLCommand;
47
52typedef BESXMLCommand *(*p_xmlcmd_builder)(const BESDataHandlerInterface &dhi);
53
64class BESXMLCommand: public BESObj {
65private:
67 static std::map<std::string, p_xmlcmd_builder> factory;
68 typedef std::map<std::string, p_xmlcmd_builder>::iterator cmd_iter;
69
70protected:
71 BESDataHandlerInterface d_xmlcmd_dhi;
72 virtual void set_response();
73
75 std::string d_cmd_log_info;
76
78
79public:
80 virtual ~BESXMLCommand()
81 {
82 }
83
89 virtual void parse_request(xmlNode *node) = 0;
90
102 virtual bool has_response() = 0;
103
108 virtual void prep_request()
109 {
110 }
111
122 {
123 return d_xmlcmd_dhi;
124 }
125
126 virtual void dump(std::ostream &strm) const;
127
128 static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd);
129 static void del_command(const std::string &cmd_str);
130 static p_xmlcmd_builder find_command(const std::string &cmd_str);
131};
132
133#endif // A_BESXMLCommand_h
134
Structure storing information used by the BES to handle the request.
top level BES object to house generic methods
Definition BESObj.h:54
Base class for the BES's commands.
virtual void prep_request()
Prepare any information needed to execute the request of this command.
virtual bool has_response()=0
Does this command return a response to the client?
static void del_command(const std::string &cmd_str)
Deletes the command called cmd_str from the list of possible commands.
virtual BESDataHandlerInterface & get_xmlcmd_dhi()
Return the current BESDataHandlerInterface.
BESXMLCommand(const BESDataHandlerInterface &base_dhi)
Creates a BESXMLCommand document given a base data handler interface object.
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual void set_response()
The request has been parsed, use the command action name to set the response handler.
virtual void parse_request(xmlNode *node)=0
Parse the XML request document beginning at the given node.
static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd)
Add a command to the possible commands allowed by this BES.
std::string d_cmd_log_info
Used only for the log.
static p_xmlcmd_builder find_command(const std::string &cmd_str)
Find the BESXMLCommand creation function with the given name.