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

response handler that returns the version of the BES and the version of any data request handlers registered with the server. More...

#include <BESVersionResponseHandler.h>

Inheritance diagram for BESVersionResponseHandler:
Collaboration diagram for BESVersionResponseHandler:

List of all members.

Public Member Functions

 BESVersionResponseHandler (const string &name)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show version;' by returning the version of the BES and the version of all registered data request handlers.
virtual string get_name () const
 return the name of this response 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 void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object
virtual ~BESVersionResponseHandler (void)

Static Public Member Functions

static BESResponseHandlerVersionResponseBuilder (const string &name)

Protected Attributes

BESResponseObject_response
string _response_name

Detailed Description

response handler that returns the version of the BES and the version of any data request handlers registered with the server.

A request 'show version;' will be handled by this response handler. It returns the version of the BES and the version of any data request handlers registered with the server.

See also:
BESResponseObject
BESRequestHandler
BESContainer
BESTransmitter

Definition at line 50 of file BESVersionResponseHandler.h.


Constructor & Destructor Documentation

Definition at line 40 of file BESVersionResponseHandler.cc.

Referenced by VersionResponseBuilder().


Member Function Documentation

void BESVersionResponseHandler::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 110 of file BESVersionResponseHandler.cc.

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

Here is the call graph for this function:

executes the command 'show version;' by returning the version of the BES and the version of all registered data request handlers.

This response handler knows how to retrieve the version of the BES server. It adds this information to a BESVersionInfo informational response object. It also forwards the request to all registered data request handlers to add their version information.

Parameters:
dhistructure that holds request and response information
See also:
BESDataHandlerInterface
BESVersionInfo
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 64 of file BESVersionResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESVersionInfo::add_library(), BESVersionInfo::begin_response(), BESVersionInfo::end_response(), BESRequestHandlerList::execute_all(), PACKAGE_NAME, PACKAGE_VERSION, BESRequestHandlerList::TheList(), and VERS_RESPONSE_STR.

Here is the call graph for this function:

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.

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 BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

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 BESVersionResponseHandler::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:
BESResponseObject
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 91 of file BESVersionResponseHandler.cc.

References BESResponseHandler::_response, and BESVersionInfo::transmit().

Here is the call graph for this function:

Definition at line 120 of file BESVersionResponseHandler.cc.

References BESVersionResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:


Member Data Documentation

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::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(), BESConfigResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().


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