bes  Updated for version 3.20.13
BESXMLInterface.h
1 // BESXMLInterface.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 BESXMLInterface_h_
34 #define BESXMLInterface_h_ 1
35 
36 #include <vector>
37 
38 #include "BESInterface.h"
39 #include "BESDataHandlerInterface.h"
40 
41 class BESXMLCommand;
42 
48 private:
50  std::vector<BESXMLCommand*> d_xml_cmd_list;
51 
53  std::string d_xml_document;
54 
56  BESDataHandlerInterface d_xml_interface_dhi;
57 
58 protected:
59  void build_data_request_plan() override;
60 
61  void execute_data_request_plan() override;
62 
63  void transmit_data() override;
64 
65  void log_status() override;
66 
67  void clean() override;
68 
69  void log_the_command(); // added for just this code. jhrg 4/20/22
70 
71 public:
72  BESXMLInterface(const std::string &cmd, std::ostream *strm);
73 
74  ~BESXMLInterface() override;
75 
76  void dump(std::ostream &strm) const override;
77 };
78 
79 #endif // BESXMLInterface_h_
80 
Structure storing information used by the BES to handle the request.
Entry point into BES, building responses to given requests.
Definition: BESInterface.h:118
Base class for the BES's commands.
Definition: BESXMLCommand.h:63
Entry point into BES using xml document requests.
void transmit_data() override
Transmit the response object.
void execute_data_request_plan() override
Execute the data request plan.
void clean() override
Clean up after the request is completed.
void log_the_command()
Log information about the command.
void log_status() override
Log the status of the request to the BESLog file.
void build_data_request_plan() override
Build the data request plan using the BESCmdParser.
void dump(std::ostream &strm) const override
dumps information about this object