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

response handler that returns the list of keys defined in the BES initialization file. More...

#include <BESConfigResponseHandler.h>

Inheritance diagram for BESConfigResponseHandler:
Inheritance graph
Collaboration diagram for BESConfigResponseHandler:
Collaboration graph

Public Member Functions

 BESConfigResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show keys;' by returning the list of all key/value pairs defined in the BES initialization file. 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 ~BESConfigResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerConfigResponseBuilder (const string &handler_name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

response handler that returns the list of keys defined in the BES initialization file.

A request 'show keys;' will be handled by this response handler. It returns the list of all key/value pairs currently defined in the BES initialization file and transmits the response as an informational response.

See Also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 49 of file BESConfigResponseHandler.h.

Constructor & Destructor Documentation

BESConfigResponseHandler::BESConfigResponseHandler ( const string &  name)

Definition at line 39 of file BESConfigResponseHandler.cc.

Referenced by ConfigResponseBuilder().

BESConfigResponseHandler::~BESConfigResponseHandler ( void  )
virtual

Definition at line 44 of file BESConfigResponseHandler.cc.

Member Function Documentation

BESResponseHandler * BESConfigResponseHandler::ConfigResponseBuilder ( const string &  handler_name)
static

Definition at line 135 of file BESConfigResponseHandler.cc.

References BESConfigResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

void BESConfigResponseHandler::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 125 of file BESConfigResponseHandler.cc.

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

Here is the call graph for this function:

void BESConfigResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command 'show keys;' by returning the list of all key/value pairs defined in the BES initialization file.

This response handler knows how to retrieve the list of keys retrieved from the BES initialization file and stored in TheBESKeys. A BESInfo informational response object is built to hold all of the key/value pairs.

The information is returned, one key per line, like:

key: "&lt;key_name&gt;", value: "&lt;key_value&gt"

Parameters
dhistructure that holds request and response information
See Also
BESDataHandlerInterface
BESInfo
TheBESKeys

Implements BESResponseHandler.

Definition at line 65 of file BESConfigResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESInfo::add_tag(), BESInfo::begin_response(), BESInfo::begin_tag(), BESInfoList::build_info(), CONFIG_RESPONSE_STR, BESInfo::end_response(), BESInfo::end_tag(), BESKeys::keys_begin(), BESKeys::keys_end(), TheBESKeys::TheKeys(), and BESInfoList::TheList().

Here is the call graph for this function:

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

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 BESConfigResponseHandler::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 106 of file BESConfigResponseHandler.cc.

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

Here is the call graph for this function:

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(), 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(), transmit(), BESShowDefsResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESSetContextResponseHandler::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: