bes Updated for version 3.20.10
BESDapErrorInfo.h
1// BESDapErrorInfo.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 BESDapErrorInfo_h_
34#define BESDapErrorInfo_h_ 1
35
36#include <string>
37
38#include "BESInfo.h"
39#include <libdap/Error.h>
40
41using namespace libdap;
42
50class BESDapErrorInfo: public BESInfo {
51private:
52 ErrorCode _error_code;
53 std::string _error_msg;
55 {
56 }
57public:
58 BESDapErrorInfo(ErrorCode ec, const std::string &msg);
59 virtual ~BESDapErrorInfo();
60
61 virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi);
62
63 virtual void add_tag(const std::string &tag_name, const std::string &tag_data, std::map<std::string, std::string> *attrs = 0);
64 virtual void begin_tag(const std::string &tag_name, std::map<std::string, std::string> *attrs = 0);
65 virtual void end_tag(const std::string &tag_name);
66
67 virtual void add_data(const std::string &s);
68 virtual void add_space(unsigned long num_spaces);
69 virtual void add_break(unsigned long num_breaks);
70
71 virtual void add_data_from_file(const std::string &key, const std::string &name);
72 virtual void add_exception(BESError &e, const std::string &admin);
73 virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi);
74 virtual void print(std::ostream &strm);
75
76 virtual void dump(std::ostream &strm) const;
77};
78
79#endif // BESDapErrorInfo_h_
80
silent informational response object
virtual void begin_tag(const std::string &tag_name, std::map< std::string, std::string > *attrs=0)
begin a tagged part of the information, information to follow
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
virtual void print(std::ostream &strm)
ignore printing the information
virtual void add_space(unsigned long num_spaces)
add a space to the informational response
virtual void add_data(const std::string &s)
add data to the informational object
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit this informational object
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual void end_tag(const std::string &tag_name)
end a tagged part of the informational response
virtual void add_exception(BESError &e, const std::string &admin)
ignore exception data to this informational object.
virtual void add_data_from_file(const std::string &key, const std::string &name)
ignore data from a file to the informational object.
virtual void add_break(unsigned long num_breaks)
add a line break to the information
Structure storing information used by the BES to handle the request.
Abstract exception class for the BES with basic string message.
Definition: BESError.h:58
informational response object
Definition: BESInfo.h:63