bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
BESXMLInfo.h
1// BESXMLInfo.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 BESXMLInfo_h_
34#define BESXMLInfo_h_ 1
35
36#include <libxml/encoding.h>
37#include <libxml/xmlwriter.h>
38
39#include "BESInfo.h"
40
48class BESXMLInfo: public BESInfo {
49private:
50 xmlTextWriterPtr _writer;
51 xmlBufferPtr _doc_buf;
52 bool _started;
53 bool _ended;
54 std::string _doc;
55
56 void cleanup();
57protected:
58 void begin_tag(const std::string &tag_name,
59 const std::string &ns,
60 const std::string &uri,
61 std::map<std::string, std::string, std::less<>> *attrs);
62public:
63 BESXMLInfo();
64 ~BESXMLInfo() override;
65
66 void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi) override;
67 void begin_response(const std::string &response_name, std::map<std::string, std::string, std::less<>> *attrs, BESDataHandlerInterface &dhi) override;
68 void end_response() override;
69
70 void add_tag(const std::string &tag_name, const std::string &tag_data, std::map<std::string, std::string, std::less<>> *attrs=nullptr) override;
71 void begin_tag(const std::string &tag_name, std::map<std::string, std::string, std::less<>> *attrs=nullptr) override;
72 void end_tag(const std::string &tag_name) override;
73
74 void add_data(const std::string &s) override;
75 void add_space(unsigned long num_spaces) override;
76 void add_break(unsigned long num_breaks) override;
77
78 void add_data_from_file(const std::string &key, const std::string &name) override;
79 void print(std::ostream &strm) override;
80 void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi) override;
81
82 void dump(std::ostream &strm) const override;
83
84 static BESInfo *BuildXMLInfo(const std::string &info_type);
85};
86
87#endif // BESXMLInfo_h_
88
Structure storing information used by the BES to handle the request.
BESInfo()
constructs a BESInfo object
Definition BESInfo.cc:52
void add_tag(const std::string &tag_name, const std::string &tag_data, std::map< std::string, std::string, std::less<> > *attrs=nullptr) override
add tagged information to the informational response
void dump(std::ostream &strm) const override
dumps information about this object
void add_data(const std::string &s) override
add data to this informational object. If buffering is not set then the information is output directl...
void add_break(unsigned long num_breaks) override
add a line break to the information
void add_data_from_file(const std::string &key, const std::string &name) override
add data from a file to the informational object
void end_tag(const std::string &tag_name) override
end a tagged part of the informational response
void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi) override
begin the informational response
Definition BESXMLInfo.cc:96
void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi) override
transmit the text information as text
void add_space(unsigned long num_spaces) override
add a space to the informational response
BESXMLInfo()
constructs an informational response object as an xml document
Definition BESXMLInfo.cc:54
void print(std::ostream &strm) override
print the information from this informational object to the specified stream
void begin_tag(const std::string &tag_name, const std::string &ns, const std::string &uri, std::map< std::string, std::string, std::less<> > *attrs)
begin a tagged part of the information, information to follow
void end_response() override
end the response