bes  Updated for version 3.20.6
BESDelContainerResponseHandler Class Reference

response handler that deletes a container More...

#include <BESDelContainerResponseHandler.h>

Collaboration diagram for BESDelContainerResponseHandler:
Collaboration graph

Public Member Functions

 BESDelContainerResponseHandler (const std::string &name)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to delete a container 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 BESResponseHandlerDelContainerResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

Detailed Description

response handler that deletes a container

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.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 51 of file BESDelContainerResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDelContainerResponseHandler::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 145 of file BESDelContainerResponseHandler.cc.

◆ execute()

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.

Parameters
dhistructure that holds request and response information
Exceptions
BESSyntaxUserErrorif unable to delete the specified container from the specified container store
See also
BESDataHandlerInterface
BESSilentInfo
BESContainer
BESContainerStorage
BESContainerStorageList

Implements BESResponseHandler.

Definition at line 81 of file BESDelContainerResponseHandler.cc.

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

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.

Returns
current response object
See also
BESResponseObject

Definition at line 82 of file BESResponseHandler.cc.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

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.

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

Definition at line 88 of file BESResponseHandler.cc.

◆ transmit()

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.

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 127 of file BESDelContainerResponseHandler.cc.


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