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:

Inheritance graph
[legend]
Collaboration diagram for BESVersionResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESVersionResponseHandler (const string &name)
virtual ~BESVersionResponseHandler (void)
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 void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object
virtual void dump (ostream &strm) const
 dumps information about this 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

Static Public Member Functions

static BESResponseHandlerVersionResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


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


Constructor & Destructor Documentation

BESVersionResponseHandler::BESVersionResponseHandler ( const string &  name  ) 

Referenced by VersionResponseBuilder().

BESVersionResponseHandler::~BESVersionResponseHandler ( void   )  [virtual]


Member Function Documentation

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

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:
dhi structure that holds request and response information
See also:
_BESDataHandlerInterface

BESVersionInfo

BESRequestHandlerList

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESVersionInfo::addBESVersion(), BESVersionInfo::begin_response(), BESVersionInfo::beginBESVersion(), BESVersionInfo::beginHandlerVersion(), BESVersionInfo::end_response(), BESVersionInfo::endBESVersion(), BESVersionInfo::endHandlerVersion(), BESRequestHandlerList::execute_all(), BESRequestHandlerList::TheList(), and VERS_RESPONSE_STR.

Here is the call graph for this function:

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:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
See also:
BESResponseObject

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

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

Here is the call graph for this function:

void BESVersionResponseHandler::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

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

Here is the call graph for this function:

BESResponseHandler * BESVersionResponseHandler::VersionResponseBuilder ( const string &  name  )  [static]

References BESVersionResponseHandler().

Referenced by BESDefaultModule::initialize().

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

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().

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

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

References BESResponseHandler::_response_name.


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

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


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

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