#include <BESShowContainersResponseHandler.h>
Inheritance diagram for BESShowContainersResponseHandler:
Public Member Functions | |
BESShowContainersResponseHandler (string name) | |
virtual | ~BESShowContainersResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'show containers;' by returning the list of currently defined containers in all container stores | |
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 const string & | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | ShowContainersResponseBuilder (string handler_name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'show containers;' will be handled by this response handler. It returns the list of currently defined containers for each container storage registered with the server and transmits the response as an informational response.
Definition at line 52 of file BESShowContainersResponseHandler.h.
BESShowContainersResponseHandler::BESShowContainersResponseHandler | ( | string | name | ) |
Definition at line 39 of file BESShowContainersResponseHandler.cc.
Referenced by ShowContainersResponseBuilder().
BESShowContainersResponseHandler::~BESShowContainersResponseHandler | ( | void | ) | [virtual] |
Definition at line 44 of file BESShowContainersResponseHandler.cc.
void BESShowContainersResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'show containers;' by returning the list of currently defined containers in all container stores
This response handler knows how to retrieve information about all containers stored with any container storage objects. This response handler creates a BESInfo response object to store the container information.
dhi | structure that holds request and response information |
BESHandlerException | if there is a problem building the response | |
BESResponseException | if a fatal error occurs building the response |
Implements BESResponseHandler.
Definition at line 65 of file BESShowContainersResponseHandler.cc.
References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESContainerStorageList::show_containers(), SHOWCONTAINERS_RESPONSE_STR, BESContainerStorageList::TheList(), and BESInfoList::TheList().
Here is the call graph for this function:
void BESShowContainersResponseHandler::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 (BESInfo) 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.
Definition at line 87 of file BESShowContainersResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
Here is the call graph for this function:
void BESShowContainersResponseHandler::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.
Definition at line 104 of file BESShowContainersResponseHandler.cc.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Here is the call graph for this function:
BESResponseHandler * BESShowContainersResponseHandler::ShowContainersResponseBuilder | ( | string | handler_name | ) | [static] |
Definition at line 114 of file BESShowContainersResponseHandler.cc.
References BESShowContainersResponseHandler().
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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by TestRequestHandler::cdf_build_help(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_help(), and OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_vers().
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 |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
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...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
Referenced by resplistT::run().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), OPENDAP_RESPONSEResponseHandler::execute(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESKeysResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), OPENDAP_RESPONSEResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESKeysResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().