BESForbiddenError Class Reference

error thrown if the BES is not allowed to access the resource requested More...

#include <BESForbiddenError.h>

Inheritance diagram for BESForbiddenError:

Inheritance graph
[legend]
Collaboration diagram for BESForbiddenError:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESForbiddenError (const string &s, const string &file, unsigned int line)
virtual void dump (ostream &strm) const
 Displays debug information about this object.
virtual int get_error_type ()
 Return the return code for this error class.
virtual string get_file ()
 get the file name where the exception was thrown
virtual int get_line ()
 get the line number where the exception was thrown
virtual string get_message ()
 get the error message for this exception
virtual void set_error_type (int type)
 Set the return code for this particular error class.
virtual void set_message (const string &msg)
 set the error message for this exception
virtual ~BESForbiddenError ()

Protected Member Functions

 BESForbiddenError ()

Protected Attributes

string _file
unsigned int _line
string _msg
unsigned int _type

Detailed Description

error thrown if the BES is not allowed to access the resource requested

Definition at line 40 of file BESForbiddenError.h.


Constructor & Destructor Documentation

BESForbiddenError::BESForbiddenError (  )  [inline, protected]

Definition at line 43 of file BESForbiddenError.h.

BESForbiddenError::BESForbiddenError ( const string &  s,
const string &  file,
unsigned int  line 
) [inline]

Definition at line 45 of file BESForbiddenError.h.

virtual BESForbiddenError::~BESForbiddenError (  )  [inline, virtual]

Definition at line 50 of file BESForbiddenError.h.


Member Function Documentation

virtual void BESForbiddenError::dump ( ostream &  strm  )  const [inline, virtual]

Displays debug information about this object.

Parameters:
strm output stream to use to dump the contents of this object

Reimplemented from BESError.

Definition at line 52 of file BESForbiddenError.h.

References BESError::dump(), BESIndent::Indent(), and BESIndent::UnIndent().

Here is the call graph for this function:

virtual int BESError::get_error_type (  )  [inline, virtual, inherited]

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

Returns:
context string

Definition at line 120 of file BESError.h.

References BESError::_type.

Referenced by BESInfo::add_exception(), BESApacheInterface::exception_manager(), and BESDapError::handleException().

virtual string BESError::get_file (  )  [inline, virtual, inherited]

get the file name where the exception was thrown

Returns:
file name

Definition at line 96 of file BESError.h.

References BESError::_file.

Referenced by BESInfo::add_exception().

virtual int BESError::get_line (  )  [inline, virtual, inherited]

get the line number where the exception was thrown

Returns:
line number

Definition at line 101 of file BESError.h.

References BESError::_line.

Referenced by BESInfo::add_exception().

virtual string BESError::get_message (  )  [inline, virtual, inherited]

get the error message for this exception

Returns:
error message

Definition at line 91 of file BESError.h.

References BESError::_msg.

Referenced by BESInfo::add_exception(), BESMemoryGlobalArea::BESMemoryGlobalArea(), BESServerHandler::BESServerHandler(), PPTClient::closeConnection(), BESApacheInterface::exception_manager(), BESInterface::finish(), BESDapError::handleException(), PPTClient::initConnection(), StandAloneApp::initialize(), ServerApp::initialize(), BESModuleApp::initialize(), BESBaseApp::initialize(), main(), StandAloneApp::run(), ServerApp::run(), CmdApp::run(), and BESModuleApp::terminate().

virtual void BESError::set_error_type ( int  type  )  [inline, virtual, inherited]

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.

Parameters:
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 112 of file BESError.h.

References BESError::_type.

Referenced by BESDapError::BESDapError(), BESDapError::handleException(), and BESApacheInterface::validate_data_request().

virtual void BESError::set_message ( const string &  msg  )  [inline, virtual, inherited]

set the error message for this exception

Parameters:
msg message string

Definition at line 86 of file BESError.h.

References BESError::_msg.

Referenced by BESDapError::handleException().


Member Data Documentation

string BESError::_file [protected, inherited]

Definition at line 56 of file BESError.h.

Referenced by BESError::dump(), and BESError::get_file().

unsigned int BESError::_line [protected, inherited]

Definition at line 57 of file BESError.h.

Referenced by BESError::dump(), and BESError::get_line().

string BESError::_msg [protected, inherited]

Definition at line 54 of file BESError.h.

Referenced by BESError::BESError(), BESError::dump(), BESError::get_message(), and BESError::set_message().

unsigned int BESError::_type [protected, inherited]

Definition at line 55 of file BESError.h.

Referenced by BESError::dump(), BESError::get_error_type(), and BESError::set_error_type().


The documentation for this class was generated from the following file:
Generated on Wed May 12 09:55:13 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7