#include <BESDelContainersResponseHandler.h>
Inheritance diagram for BESDelContainersResponseHandler:
Public Member Functions | |
BESDelContainersResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to delete all containers from a specified container store. | |
virtual string | get_name () const |
return the name of this response 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 void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESDelContainersResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | DelContainersResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
Possible requests handled by this response handler are:
delete containers [from <store_name>];
An informational response object is created and returned to the requester to inform them whether the request was successful.
Definition at line 52 of file BESDelContainersResponseHandler.h.
BESDelContainersResponseHandler::BESDelContainersResponseHandler | ( | const string & | name | ) |
Definition at line 45 of file BESDelContainersResponseHandler.cc.
Referenced by DelContainersResponseBuilder().
BESDelContainersResponseHandler::~BESDelContainersResponseHandler | ( | void | ) | [virtual] |
Definition at line 50 of file BESDelContainersResponseHandler.cc.
BESResponseHandler * BESDelContainersResponseHandler::DelContainersResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 151 of file BESDelContainersResponseHandler.cc.
References BESDelContainersResponseHandler().
Referenced by BESDefaultModule::initialize().
Here is the call graph for this function:
void BESDelContainersResponseHandler::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 141 of file BESDelContainersResponseHandler.cc.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Here is the call graph for this function:
void BESDelContainersResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command to delete all containers from a specified container store.
Removes all containers from a specified container storage found in BESContainerStorageList::TheList(). If no container store is specified, the default is volatile.
The response built is a silent informational object. The only response that a client would receive would be if there were an exception thrown attempting to delete the containers.
dhi | structure that holds request and response information |
BESSyntaxUserError | if unable to delete all containers from the specified container store |
Implements BESResponseHandler.
Definition at line 75 of file BESDelContainersResponseHandler.cc.
References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESDataHandlerInterface::data, BESContainerStorage::del_containers(), DELETE_CONTAINERS_STR, BESContainerStorageList::find_persistence(), PERSISTENCE_VOLATILE, STORE_NAME, and BESContainerStorageList::TheList().
Here is the call graph for this function:
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...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().
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.
void BESDelContainersResponseHandler::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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 122 of file BESDelContainersResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
Here is the call graph for this function:
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().