#include <BESCatalogResponseHandler.h>
Public Member Functions | |
BESCatalogResponseHandler (const string &name) | |
virtual | ~BESCatalogResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node. | |
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 BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_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 BESResponseHandler * | CatalogResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'show catalog [for <node>];' or 'show leaves for <node>; will be handled by this response handler. It returns nodes or leaves either at the root level if no node is specified in the request, or the nodes or leaves under the specified node.
BESCatalogResponseHandler::BESCatalogResponseHandler | ( | const string & | name | ) |
Referenced by CatalogResponseBuilder().
BESCatalogResponseHandler::~BESCatalogResponseHandler | ( | void | ) | [virtual] |
void BESCatalogResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node.
The response object BESInfo is created to store the information.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), CATALOG_OR_INFO, CATALOG_RESPONSE, CATALOG_RESPONSE_STR, CONTAINER, _BESDataHandlerInterface::data, BESInfo::end_response(), BESCatalogList::show_catalog(), SHOW_INFO_RESPONSE_STR, BESCatalogList::TheCatalogList(), and BESInfoList::TheList().
void BESCatalogResponseHandler::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
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
References BESResponseHandler::_response, and BESInfo::transmit().
void BESCatalogResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
BESResponseHandler * BESCatalogResponseHandler::CatalogResponseBuilder | ( | const string & | name | ) | [static] |
References BESCatalogResponseHandler().
Referenced by BESDapModule::initialize().
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.
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.
o | new response object used to replace the current one |
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...
References BESResponseHandler::_response_name.
string BESResponseHandler::_response_name [protected, inherited] |
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::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(), execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::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(), transmit(), and BESResponseHandler::~BESResponseHandler().