TestResponseHandler Class Reference

#include <TestResponseHandler.h>

Inheritance diagram for TestResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for TestResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TestResponseHandler (const string &name)
virtual ~TestResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 knows how to build a requested response object
virtual void transmit (BESDataHandlerInterface &dhi)
virtual void execute_each (BESDataHandlerInterface &dhi)
virtual void execute_all (BESDataHandlerInterface &dhi)
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the respobse object built by the execute command using the specified transmitter object
virtual BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
virtual string get_name () const
 return the name of this response object
virtual void dump (ostream &strm) const
 dumps information about this object

Static Public Member Functions

static BESResponseHandlerTestResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

Definition at line 8 of file TestResponseHandler.h.


Constructor & Destructor Documentation

TestResponseHandler::TestResponseHandler ( const string &  name  ) 

Definition at line 11 of file TestResponseHandler.cc.

Referenced by TestResponseBuilder().

TestResponseHandler::~TestResponseHandler ( void   )  [virtual]

Definition at line 16 of file TestResponseHandler.cc.


Member Function Documentation

void TestResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

knows how to build a requested response object

Derived instances of this abstract base class know how to create a specific response object and what objects (including itself) to pass that response object to for it to be filled in.

Parameters:
dhi structure that holds request and response information
Exceptions:
BESHandlerException if there is a problem building the response object
BESResponseException upon fatal error building the response object
See also:
_BESDataHandlerInterface

BESResponseObject

Implements BESResponseHandler.

Definition at line 21 of file TestResponseHandler.cc.

void TestResponseHandler::transmit ( BESDataHandlerInterface dhi  )  [virtual]

Definition at line 26 of file TestResponseHandler.cc.

void TestResponseHandler::execute_each ( BESDataHandlerInterface dhi  )  [virtual]

Definition at line 31 of file TestResponseHandler.cc.

void TestResponseHandler::execute_all ( BESDataHandlerInterface dhi  )  [virtual]

Definition at line 36 of file TestResponseHandler.cc.

void TestResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

transmit the respobse object built by the execute command using the specified transmitter object

Parameters:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
Exceptions:
BESTransmitException if problem transmitting the response obj
See also:
BESResponseObject

BESTransmitter

_BESDataHandlerInterface

BESTransmitException

Implements BESResponseHandler.

Definition at line 41 of file TestResponseHandler.cc.

BESResponseHandler * TestResponseHandler::TestResponseBuilder ( const string &  name  )  [static]

Definition at line 47 of file TestResponseHandler.cc.

References TestResponseHandler().

Referenced by resplistT::run().

Here is the call graph for this function:

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.

Returns:
current response object
See also:
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by TestRequestHandler::cdf_build_help(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_help(), and OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_vers().

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.

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

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

Returns:
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name.

Referenced by resplistT::run().

void BESResponseHandler::dump ( ostream &  strm  )  const [virtual, inherited]

dumps information about this object

Displays the pointer value of this instance along with the name of this response handler and, if present, dumps the response object itself.

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

Implements BESObj.

Reimplemented in BESCatalogResponseHandler, BESDASResponseHandler, BESDataResponseHandler, BESDDSResponseHandler, BESDDXResponseHandler, BESDefineResponseHandler, BESDelContainerResponseHandler, BESDelContainersResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESHelpResponseHandler, BESKeysResponseHandler, BESProcIdResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESStatusResponseHandler, BESStreamResponseHandler, BESVersionResponseHandler, TestEhmResponseHandler, TestSigResponseHandler, and OPENDAP_RESPONSEResponseHandler.

Definition at line 74 of file BESResponseHandler.cc.

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

Referenced by TestSigResponseHandler::dump(), TestEhmResponseHandler::dump(), OPENDAP_RESPONSEResponseHandler::dump(), BESVersionResponseHandler::dump(), BESStreamResponseHandler::dump(), BESStatusResponseHandler::dump(), BESShowDefsResponseHandler::dump(), BESShowContextResponseHandler::dump(), BESShowContainersResponseHandler::dump(), BESSetContextResponseHandler::dump(), BESSetContainerResponseHandler::dump(), BESProcIdResponseHandler::dump(), BESKeysResponseHandler::dump(), BESHelpResponseHandler::dump(), BESDelDefsResponseHandler::dump(), BESDelDefResponseHandler::dump(), BESDelContainersResponseHandler::dump(), BESDelContainerResponseHandler::dump(), BESDefineResponseHandler::dump(), BESDDXResponseHandler::dump(), BESDDSResponseHandler::dump(), BESDataResponseHandler::dump(), _BESDataHandlerInterface::dump(), BESDASResponseHandler::dump(), and BESCatalogResponseHandler::dump().

Here is the call graph for this function:


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().

BESResponseObject* BESResponseHandler::_response [protected, inherited]

Definition at line 85 of file BESResponseHandler.h.

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


The documentation for this class was generated from the following files:
Generated on Sat Jan 19 04:16:54 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.4