OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESShowErrorResponseHandler Class Reference

response handler that throws the requested exception type More...

#include <BESShowErrorResponseHandler.h>

Inheritance diagram for BESShowErrorResponseHandler:
Inheritance graph
Collaboration diagram for BESShowErrorResponseHandler:
Collaboration graph

Public Member Functions

 BESShowErrorResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 throws a specific exception to test error handling in client More...
 
virtual string get_name () const
 return the name of this response object More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object More...
 
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object More...
 
virtual ~BESShowErrorResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

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;

See also
BESResponseObject
BESContainer
BESTransmitter
BESError

Definition at line 50 of file BESShowErrorResponseHandler.h.

Constructor & Destructor Documentation

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.

Member Function Documentation

void BESShowErrorResponseHandler::dump ( ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 142 of file BESShowErrorResponseHandler.cc.

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

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
Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo
BESContextManager

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
inlinevirtualinherited

return the name of this response object

This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name.

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

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.

Returns
current response object
See also
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by DapRequestHandler::dap_build_das(), DapRequestHandler::dap_build_data(), DapRequestHandler::dap_build_dds(), DapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_help(), DapRequestHandler::dap_build_vers(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

BESResponseHandler * BESShowErrorResponseHandler::ResponseBuilder ( const string &  name)
static

Definition at line 152 of file BESShowErrorResponseHandler.cc.

References BESShowErrorResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

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.

Parameters
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

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.

Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 128 of file BESShowErrorResponseHandler.cc.

Member Data Documentation

BESResponseObject* BESResponseHandler::_response
protectedinherited

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESServicesResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDDXResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

string BESResponseHandler::_response_name
protectedinherited

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