OPeNDAP Hyrax Back End Server (BES) Updated for version 3.8.3
|
response handler that throws the requested exception type More...
#include <BESShowErrorResponseHandler.h>
Public Member Functions | |
BESShowErrorResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
throws a specific exception to test error handling in client | |
virtual string | get_name () const |
return the name of this response object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESShowErrorResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | ResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
response handler that throws the requested exception type
This response handler tests error handling of a client by throwing the requested error type
show error error_type_num;
Definition at line 50 of file BESShowErrorResponseHandler.h.
BESShowErrorResponseHandler::BESShowErrorResponseHandler | ( | const string & | name | ) |
Definition at line 45 of file BESShowErrorResponseHandler.cc.
Referenced by ResponseBuilder().
BESShowErrorResponseHandler::~BESShowErrorResponseHandler | ( | void | ) | [virtual] |
Definition at line 50 of file BESShowErrorResponseHandler.cc.
void BESShowErrorResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 147 of file BESShowErrorResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void BESShowErrorResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
throws a specific exception to test error handling in client
Where error_type_num is one of the following 1. Internal Error - the error is internal to the BES Server 2. Internal Fatal Error - error is fatal, can not continue 3. Syntax User Error - the requester has a syntax error in request or config 4. Forbidden Error - the requester is forbidden to see the resource 5. Not Found Error - the resource can not be found
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 69 of file BESShowErrorResponseHandler.cc.
References BESDataHandlerInterface::action, BES_FORBIDDEN_ERROR, BES_INTERNAL_ERROR, BES_INTERNAL_FATAL_ERROR, BES_NOT_FOUND_ERROR, BES_SYNTAX_USER_ERROR, BESDataHandlerInterface::data, and SHOW_ERROR_TYPE.
virtual string BESResponseHandler::get_name | ( | ) | const [inline, virtual, inherited] |
return the name of this response object
This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
BESResponseObject * BESResponseHandler::get_response_object | ( | ) | [virtual, inherited] |
return the current response object
Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().
BESResponseHandler * BESShowErrorResponseHandler::ResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 157 of file BESShowErrorResponseHandler.cc.
References BESShowErrorResponseHandler().
Referenced by BESDefaultModule::initialize().
BESResponseObject * BESResponseHandler::set_response_object | ( | BESResponseObject * | o | ) | [virtual, inherited] |
replaces the current response object with the specified one, returning the current response object
This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.
The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
void BESShowErrorResponseHandler::transmit | ( | BESTransmitter * | transmitter, |
BESDataHandlerInterface & | dhi | ||
) | [virtual] |
transmit the response object built by the execute command using the specified transmitter object
If a response object was built then transmit it as text using the specified transmitter object.
transmitter | object that knows how to transmit specific basic types |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 133 of file BESShowErrorResponseHandler.cc.
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().