bes  Updated for version 3.17.4
BESDelDefResponseHandler Class Reference

response handler that deletes a definition from a specified definition store More...

#include <BESDelDefResponseHandler.h>

Inheritance diagram for BESDelDefResponseHandler:
Inheritance graph

Public Member Functions

 BESDelDefResponseHandler (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 definition More...
 
virtual string get_name () const
 return the name of this response object More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_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 BESResponseHandlerDelDefResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

Possible requests handled by this response handler are:

delete definition <def_name> [from <store_name>];

An informational response object is created and returned to the requester to inform them whether the request was successful.

See also
BESResponseObject
BESDefine
BESDefinitionStorage
BESTransmitter

Definition at line 53 of file BESDelDefResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDelDefResponseHandler::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 148 of file BESDelDefResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESDelDefResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

Removes a definition from a specified definition storage found in BESDefinitionStorageList::TheList(). 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 definition.

Parameters
dhistructure that holds request and response information
Exceptions
BESSyntaxUserErrorif unable to delete the specified definition from the specified definition store. object
See also
BESDataHandlerInterface
BESSilentInfo
BESDefine
BESDefinitionStorage
BESDefinitionStorageList

Implements BESResponseHandler.

Definition at line 75 of file BESDelDefResponseHandler.cc.

References BESDataHandlerInterface::data, BESDefinitionStorage::del_definition(), and BESDefinitionStorageList::find_persistence().

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
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...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::dump().

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns
current response object
See also
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
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.

Parameters
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 59 of file BESResponseHandler.cc.

◆ transmit()

void BESDelDefResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

If a response object was built then transmit it as text using the specified transmitter object.

Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 129 of file BESDelDefResponseHandler.cc.

References BESInfo::transmit().


The documentation for this class was generated from the following files: