BESError.h

// BESError.h
 
// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.
 
// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301
 
// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>
 
#ifndef BESError_h_
#define BESError_h_ 1
 
#include <string>
#include <stdexcept>
 
#include "BESObj.h"
 
// Forward declaration of BESInfo since BESInfo.h
// already includes BESError.h
class BESInfo;
 
#define BES_INTERNAL_ERROR 1
 
// BES_INTERNAL_FATAL_ERROR will cause the bes listener to exit()
// while the others (BES_INTERNAL_ERROR, ...) won't.
// But, see the new option BES.ExitOnInternalError, which causes the
// BES to exit on an InternalError.
#define BES_INTERNAL_FATAL_ERROR 2
 
#define BES_SYNTAX_USER_ERROR 3
#define BES_FORBIDDEN_ERROR 4
#define BES_NOT_FOUND_ERROR 5
 
// I added this for the timeout feature. jhrg 12/28/15
#define BES_TIMEOUT_ERROR 6
 
// A BES_HTTP_ERROR is thrown when a request to another service fails.
#define BES_HTTP_ERROR 7

class BESError : public std::exception, public BESObj {
private:
    std::string _msg{"UNDEFINED"};
    unsigned int _type{0};
    std::string _file;
    unsigned int _line{0};
 
public:
    BESError() = default;

    BESError(std::string msg, unsigned int type, std::string file, unsigned int line) :
            _msg(std::move(msg)), _type(type), _file(std::move(file)), _line(line) {}

    BESError(const BESError &src) noexcept
            : exception(), _msg(src._msg), _type(src._type), _file(src._file), _line(src._line) {}
 
    ~BESError() override = default;

    BESError &operator=(const BESError &rhs) = delete;

    void set_message(const std::string &msg) {
        _msg = msg;
    }

    virtual void add_my_error_details_to(BESInfo & /*bes_info*/) const {
        // Most BESError types have simple semantics.
        // Adding their pertinent information to the BESInfo object
        // is handled by interrogating the BESError base class methods.
        // This includes the basic details: FILE, LINE, and message.
        // Others error types,  like HttpError, are more complex in both state and
        // API. In order for these types of error to be ingested into a BESInfo
        // object to be serialized to the BESClient this method is called.
        // Thus, in many cases the child of BESError does not override this
        // method, but more complex type like HttpError take advantage of this.
    }

    std::string get_message() const {
        return _msg;
    }

    std::string get_file() const {
        return _file;
    }

    unsigned int get_line() const {
        return _line;
    }
 
    // Return the message, file and line. Over load this for special messages, etc.
    virtual std::string get_verbose_message() const;

    void set_bes_error_type(unsigned int type) {
        _type = type;
    }

    unsigned int get_bes_error_type() const {
        return _type;
    }
 
    // The pointer is valid only for the lifetime of the BESError instance. jhrg 3/29/22

    const char *what() const noexcept override {
        return _msg.c_str();
    }

    void dump(std::ostream &strm) const override;
 
    virtual std::string error_name() const { return "BESError"; }
 
};
 
#endif // BESError_h_