bes Updated for version 3.20.13
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 virtual void begin_tag(const std::string &tag_name, const std::string &ns, const std::string &uri, std::map<std::string, std::string> *attrs = 0);
59public:
60 BESXMLInfo();
61 virtual ~BESXMLInfo();
62
63 virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi);
64 virtual void begin_response(const std::string &response_name, std::map<std::string, std::string> *attrs, BESDataHandlerInterface &dhi);
65 virtual void end_response();
66
67 virtual void add_tag(const std::string &tag_name, const std::string &tag_data, std::map<std::string, std::string> *attrs = 0);
68 virtual void begin_tag(const std::string &tag_name, std::map<std::string, std::string> *attrs = 0);
69 virtual void end_tag(const std::string &tag_name);
70
71 virtual void add_data(const std::string &s);
72 virtual void add_space(unsigned long num_spaces);
73 virtual void add_break(unsigned long num_breaks);
74
75 virtual void add_data_from_file(const std::string &key, const std::string &name);
76 virtual void print(std::ostream &strm);
77 virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi);
78
79 virtual void dump(std::ostream &strm) const;
80
81 static BESInfo *BuildXMLInfo(const std::string &info_type);
82};
83
84#endif // BESXMLInfo_h_
85
Structure storing information used by the BES to handle the request.
informational response object
Definition: BESInfo.h:63
represents an xml formatted response object
Definition: BESXMLInfo.h:48
virtual void add_tag(const std::string &tag_name, const std::string &tag_data, std::map< std::string, std::string > *attrs=0)
add tagged information to the informational response
Definition: BESXMLInfo.cc:269
virtual void end_tag(const std::string &tag_name)
end a tagged part of the informational response
Definition: BESXMLInfo.cc:387
virtual void add_data_from_file(const std::string &key, const std::string &name)
add data from a file to the informational object
Definition: BESXMLInfo.cc:462
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the text information as text
Definition: BESXMLInfo.cc:482
virtual void end_response()
end the response
Definition: BESXMLInfo.cc:215
virtual void add_space(unsigned long num_spaces)
add a space to the informational response
Definition: BESXMLInfo.cc:419
virtual void add_break(unsigned long num_breaks)
add a line break to the information
Definition: BESXMLInfo.cc:432
BESXMLInfo()
constructs an informational response object as an xml document
Definition: BESXMLInfo.cc:54
virtual void add_data(const std::string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESXMLInfo.cc:441
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESXMLInfo.cc:96
virtual void begin_tag(const std::string &tag_name, const std::string &ns, const std::string &uri, std::map< std::string, std::string > *attrs=0)
begin a tagged part of the information, information to follow
Definition: BESXMLInfo.cc:334
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESXMLInfo.cc:510
virtual void print(std::ostream &strm)
print the information from this informational object to the specified stream
Definition: BESXMLInfo.cc:495