Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

BESKeysResponseHandler Class Reference

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

#include <BESKeysResponseHandler.h>

Inheritance diagram for BESKeysResponseHandler:

[legend]
Collaboration diagram for BESKeysResponseHandler:
[legend]
List of all members.

Public Member Functions

 BESKeysResponseHandler (string name)
virtual ~BESKeysResponseHandler (void)
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.
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 const string & get_name () const
 return the name of this response object

Static Public Member Functions

static BESResponseHandlerKeysResponseBuilder (string handler_name)

Protected Attributes

string _response_name
BESResponseObject_response

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


Constructor & Destructor Documentation

BESKeysResponseHandler::BESKeysResponseHandler string  name  ) 
 

BESKeysResponseHandler::~BESKeysResponseHandler void   )  [virtual]
 


Member Function Documentation

void BESKeysResponseHandler::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.

void BESKeysResponseHandler::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:
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

BESInfo

TheBESKeys

Implements BESResponseHandler.

virtual const 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

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

BESResponseHandler * BESKeysResponseHandler::KeysResponseBuilder string  handler_name  )  [static]
 

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

void BESKeysResponseHandler::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:
BESInfo

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.


Member Data Documentation

BESResponseObject* BESResponseHandler::_response [protected, inherited]
 

string BESResponseHandler::_response_name [protected, inherited]
 


The documentation for this class was generated from the following files:
Generated on Thu May 3 23:11:01 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.4