OPeNDAP Hyrax Back End Server (BES)
Updated for version 3.8.3
|
Abstract exception class for the BES with basic string message. More...
#include <BESError.h>
Public Member Functions | |
BESError (const string &msg, unsigned int type, const string &file, unsigned int line) | |
constructor that takes message, type of error, source file the error originated and the line number in the source file More... | |
virtual void | dump (ostream &strm) const |
Displays debug information about this object. More... | |
virtual int | get_error_type () |
Return the return code for this error class. More... | |
virtual string | get_file () |
get the file name where the exception was thrown More... | |
virtual int | get_line () |
get the line number where the exception was thrown More... | |
virtual string | get_message () |
get the error message for this exception More... | |
virtual void | set_error_type (int type) |
Set the return code for this particular error class. More... | |
virtual void | set_message (const string &msg) |
set the error message for this exception More... | |
virtual | ~BESError () |
Protected Member Functions | |
BESError () | |
Protected Attributes | |
string | _file |
unsigned int | _line |
string | _msg |
unsigned int | _type |
Abstract exception class for the BES with basic string message.
Definition at line 51 of file BESError.h.
|
inlineprotected |
Definition at line 58 of file BESError.h.
References _msg.
|
inline |
constructor that takes message, type of error, source file the error originated and the line number in the source file
msg | error message |
type | type of error generated. Default list of error types are defined above as internal error, internal fatal error, syntax/user error, resource forbidden error, resource not found error. |
file | the filename in which this error object was created |
line | the line number within the file in which this error object was created |
Definition at line 74 of file BESError.h.
|
inlinevirtual |
Definition at line 78 of file BESError.h.
|
virtual |
Displays debug information about this object.
dumps information about this object
strm | output stream to use to dump the contents of this object |
Displays the pointer value of this instance along with the exception message, the file from which the exception was generated, and the line number in that file.
strm | C++ i/o stream to dump the information to |
Implements BESObj.
Reimplemented in BESDapError, BESInternalError, BESInternalFatalError, BESSyntaxUserError, BESForbiddenError, and BESNotFoundError.
Definition at line 44 of file BESError.cc.
References _file, _line, _msg, _type, BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Referenced by BESForbiddenError::dump(), BESNotFoundError::dump(), BESInternalFatalError::dump(), BESSyntaxUserError::dump(), BESInternalError::dump(), and BESDapError::dump().
|
inlinevirtual |
Return the return code for this error class.
Returns the return code for this error class, which could represent the need to terminate or do something specific base on the error
Definition at line 135 of file BESError.h.
References _type.
Referenced by BESInfo::add_exception(), BESApacheInterface::exception_manager(), DaemonCommandHandler::handle(), BESExceptionManager::handle_exception(), and BESDapError::handleException().
|
inlinevirtual |
get the file name where the exception was thrown
Definition at line 102 of file BESError.h.
References _file.
Referenced by BESInfo::add_exception().
|
inlinevirtual |
get the line number where the exception was thrown
Definition at line 110 of file BESError.h.
References _line.
Referenced by BESInfo::add_exception().
|
inlinevirtual |
get the error message for this exception
Definition at line 94 of file BESError.h.
References _msg.
Referenced by BESInfo::add_exception(), BESMemoryGlobalArea::BESMemoryGlobalArea(), BESServerHandler::BESServerHandler(), PPTClient::closeConnection(), BESApacheInterface::exception_manager(), BESCatalogUtils::exclude(), BESInterface::finish(), BESDapResponseCache::get_instance(), BESStoredDapResultCache::get_instance(), DaemonCommandHandler::handle(), BESDapError::handleException(), BESCatalogUtils::include(), PPTClient::initConnection(), ServerApp::initialize(), StandAloneApp::initialize(), BESModuleApp::initialize(), main(), ServerApp::run(), StandAloneApp::run(), CmdApp::run(), BESModuleApp::terminate(), and CmdTranslation::translate().
|
inlinevirtual |
Set the return code for this particular error class.
Sets the return code for this error class, which could represent the need to terminate or do something specific based on the error.
type | the type of error this error object represents. Can be one of BES_INTERNAL_ERROR, BES_INTERNAL_FATAL_ERROR, BES_SYNTAX_USER_ERROR, BES_FORBIDDEN_ERROR, BES_NOT_FOUND_ERROR |
Definition at line 124 of file BESError.h.
References _type.
Referenced by BESDapError::handleException(), and BESApacheInterface::validate_data_request().
|
inlinevirtual |
set the error message for this exception
msg | message string |
Definition at line 86 of file BESError.h.
References _msg.
Referenced by BESDapError::handleException().
|
protected |
Definition at line 55 of file BESError.h.
Referenced by dump(), and get_file().
|
protected |
Definition at line 56 of file BESError.h.
Referenced by dump(), and get_line().
|
protected |
Definition at line 53 of file BESError.h.
Referenced by BESError(), dump(), get_message(), and set_message().
|
protected |
Definition at line 54 of file BESError.h.
Referenced by dump(), get_error_type(), and set_error_type().