OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESDelContainersResponseHandler Class Reference

response handler that deletes all containers from a specified container store More...

#include <BESDelContainersResponseHandler.h>

Inheritance diagram for BESDelContainersResponseHandler:
Inheritance graph
Collaboration diagram for BESDelContainersResponseHandler:
Collaboration graph

Public Member Functions

 BESDelContainersResponseHandler (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 all containers from a specified container store. 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...
 
virtual ~BESDelContainersResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerDelContainersResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

response handler that deletes all containers from a specified container store

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.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 52 of file BESDelContainersResponseHandler.h.

Constructor & Destructor Documentation

◆ BESDelContainersResponseHandler()

BESDelContainersResponseHandler::BESDelContainersResponseHandler ( const string &  name)

Definition at line 45 of file BESDelContainersResponseHandler.cc.

Referenced by DelContainersResponseBuilder().

◆ ~BESDelContainersResponseHandler()

BESDelContainersResponseHandler::~BESDelContainersResponseHandler ( void  )
virtual

Definition at line 50 of file BESDelContainersResponseHandler.cc.

Member Function Documentation

◆ DelContainersResponseBuilder()

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:

◆ dump()

void BESDelContainersResponseHandler::dump ( 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 141 of file BESDelContainersResponseHandler.cc.

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

◆ execute()

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.

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

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:

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

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...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name, and BESResponseHandler::dump().

Here is the call graph for this function:

◆ 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 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

◆ 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 59 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

◆ transmit()

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.

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 122 of file BESDelContainersResponseHandler.cc.

References BESResponseHandler::_response, and BESInfo::transmit().

Here is the call graph for this function:

Member Data Documentation

◆ _response

BESResponseObject* BESResponseHandler::_response
protectedinherited

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESServicesResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::execute(), execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDDXResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESHelpResponseHandler::transmit(), transmit(), BESCatalogResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

◆ _response_name

string BESResponseHandler::_response_name
protectedinherited

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