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 ~BESForbiddenError ()
virtual void dump (ostream &strm) const
 Displays debug information about this object.
virtual void set_message (const string &msg)
 set the error message for this exception
virtual string get_message ()
 get the error message for this exception
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 void set_error_type (int type)
 Set the return code for this particular error class.
virtual int get_error_type ()
 Return the return code for this error class.

Protected Member Functions

 BESForbiddenError ()

Protected Attributes

string _msg
unsigned int _type
string _file
unsigned int _line


Detailed Description

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

Constructor & Destructor Documentation

BESForbiddenError::BESForbiddenError (  )  [inline, protected]

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

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


Member Function Documentation

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

Displays debug information about this object.

dumps information about this object

Parameters:
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.

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESError.

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

Here is the call graph for this function:

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

set the error message for this exception

Parameters:
msg message string

References BESError::_msg.

Referenced by BESDapError::handleException().

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

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

get the file name where the exception was thrown

Returns:
file name

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

References BESError::_line.

Referenced by BESInfo::add_exception().

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:
return_code code used when returning from the error

References BESError::_type.

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

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

References BESError::_type.

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


Member Data Documentation

string BESError::_msg [protected, inherited]

unsigned int BESError::_type [protected, inherited]

string BESError::_file [protected, inherited]

unsigned int BESError::_line [protected, inherited]


The documentation for this class was generated from the following file:

Generated on Thu Sep 11 07:57:22 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6