OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLInterface.h
Go to the documentation of this file.
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 <new>
37 #include <vector>
38 
39 using std::new_handler ;
40 using std::bad_alloc ;
41 using std::vector ;
42 
43 #include "BESBasicInterface.h"
44 #include "BESXMLUtils.h"
45 
46 class BESXMLCommand ;
47 
53 {
54 private:
55  vector<BESXMLCommand *> _cmd_list ;
56  BESDataHandlerInterface _base_dhi ;
57 protected:
58  virtual void initialize() ;
59  virtual void validate_data_request() ;
60  virtual void build_data_request_plan() ;
61  virtual void execute_data_request_plan() ;
62  virtual void invoke_aggregation();
63  virtual void transmit_data() ;
64  virtual void log_status() ;
65  virtual void report_request() ;
66  virtual void clean() ;
67 public:
68  BESXMLInterface( const string &cmd,
69  ostream *strm ) ;
70  virtual ~BESXMLInterface() ;
71 
72  virtual int execute_request( const string &from ) ;
73 
74  virtual void dump( ostream &strm ) const ;
75 } ;
76 
77 #endif // BESXMLInterface_h_
78 
virtual int execute_request(const string &from)
Override execute_request in order to register memory pool.
Entry point into BES using string command requests.
virtual void invoke_aggregation()
Invoke the aggregation server, if there is one.
virtual void initialize()
Initialize the BES.
virtual void log_status()
Log the status of the request to the BESLog file.
virtual void build_data_request_plan()
Build the data request plan using the BESCmdParser.
virtual void execute_data_request_plan()
Execute the data request plan.
virtual ~BESXMLInterface()
virtual void clean()
Clean up after the request is completed.
virtual void report_request()
Report the request and status of the request.
Entry point into BES using xml document requests.
BESXMLInterface(const string &cmd, ostream *strm)
virtual void validate_data_request()
Validate the incoming request information.
Structure storing information used by the BES to handle the request.
virtual void transmit_data()
Transmit the response object.
virtual void dump(ostream &strm) const
dumps information about this object