BESDelContainersResponseHandler Class Reference

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

#include <BESDelContainersResponseHandler.h>

Inheritance diagram for BESDelContainersResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDelContainersResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESDelContainersResponseHandler (string name)
virtual ~BESDelContainersResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to delete all containers from a specified container store.
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 BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
virtual const string & get_name () const
 return the name of this response object

Static Public Member Functions

static BESResponseHandlerDelContainersResponseBuilder (string handler_name)

Protected Attributes

string _response_name
BESResponseObject_response

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 ( string  name  ) 

Definition at line 45 of file BESDelContainersResponseHandler.cc.

Referenced by DelContainersResponseBuilder().

BESDelContainersResponseHandler::~BESDelContainersResponseHandler ( void   )  [virtual]

Definition at line 50 of file BESDelContainersResponseHandler.cc.


Member Function Documentation

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

The response object built is a BESInfo object. Status of the deletion will be added to the informational object, one of:

Successfully deleted all containers
Container storage "&lt;store_name&gt;" does not exist. Unable to delete containers

Parameters:
dhi structure that holds request and response information
Exceptions:
BESHandlerException if there is a problem building the response object
BESResponseException upon fatal error building the response object
See also:
_BESDataHandlerInterface

BESInfo

BESDefinitionStorageList

BESDefine

BESContainerStorage

BESContainerStorageList

Implements BESResponseHandler.

Definition at line 80 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:

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:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
See also:
BESInfo

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 127 of file BESDelContainersResponseHandler.cc.

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

Here is the call graph for this function:

void BESDelContainersResponseHandler::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 144 of file BESDelContainersResponseHandler.cc.

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

Here is the call graph for this function:

BESResponseHandler * BESDelContainersResponseHandler::DelContainersResponseBuilder ( string  handler_name  )  [static]

Definition at line 154 of file BESDelContainersResponseHandler.cc.

References BESDelContainersResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

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.

Returns:
current response object
See also:
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by TestRequestHandler::cdf_build_help(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_help(), and OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_vers().

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.

Parameters:
o new 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.

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

Returns:
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name.

Referenced by resplistT::run().


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().

BESResponseObject* BESResponseHandler::_response [protected, inherited]

Definition at line 85 of file BESResponseHandler.h.

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


The documentation for this class was generated from the following files:
Generated on Wed Aug 29 03:23:50 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2