#include <BESDelContainerResponseHandler.h>
Public Member Functions | |
BESDelContainerResponseHandler (const string &name) | |
virtual | ~BESDelContainerResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to delete a container | |
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 * | DelContainerResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
Possible requests handled by this response handler are:
delete container <container_name> [from <store_name>];
An informational response object is created and returned to the requester to inform them whether the request was successful or not.
BESDelContainerResponseHandler::BESDelContainerResponseHandler | ( | const string & | name | ) |
Referenced by DelContainerResponseBuilder().
BESDelContainerResponseHandler::~BESDelContainerResponseHandler | ( | void | ) | [virtual] |
void BESDelContainerResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command to delete a container
Removes a specified container from a specified container store. 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 container.
dhi | structure that holds request and response information |
BESSyntaxUserError | if unable to delete the specified container from the specified container store |
Implements BESResponseHandler.
References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, CONTAINER_NAME, _BESDataHandlerInterface::data, BESContainerStorage::del_container(), DELETE_CONTAINER_STR, BESContainerStorageList::find_persistence(), PERSISTENCE_VOLATILE, STORE_NAME, and BESContainerStorageList::TheList().
void BESDelContainerResponseHandler::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.
References BESResponseHandler::_response, and BESInfo::transmit().
void BESDelContainerResponseHandler::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 * BESDelContainerResponseHandler::DelContainerResponseBuilder | ( | const string & | name | ) | [static] |
References BESDelContainerResponseHandler().
Referenced by BESDefaultModule::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(), execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::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(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().