bes
Updated for version 3.17.4
|
response handler that deletes all definitions from a specified definition store. More...
#include <BESDelDefsResponseHandler.h>
Public Member Functions | |
BESDelDefsResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to delete a container, a definition, or all definitions. More... | |
virtual string | get_name () const |
return the name of this response object More... | |
virtual BESResponseObject * | get_response_object () |
return the current response object More... | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object More... | |
Static Public Member Functions | |
static BESResponseHandler * | DelDefsResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
Possible requests handled by this response handler are:
delete definitions [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 53 of file BESDelDefsResponseHandler.h.
|
virtual |
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 137 of file BESDelDefsResponseHandler.cc.
References BESResponseHandler::dump().
|
virtual |
Removes all definitions from the specified definition store. If no definition 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 definitions from the store.
dhi | structure that holds request and response information |
BESSyntaxUserError | if unable to delete all definitions from the specified definition store. object |
Implements BESResponseHandler.
Definition at line 75 of file BESDelDefsResponseHandler.cc.
References BESDataHandlerInterface::data, BESDefinitionStorage::del_definitions(), and BESDefinitionStorageList::find_persistence().
|
inlinevirtualinherited |
This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::dump().
|
virtualinherited |
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.
|
virtualinherited |
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.
|
virtual |
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 118 of file BESDelDefsResponseHandler.cc.
References BESInfo::transmit().