BESDelDefResponseHandler Class Reference

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

#include <BESDelDefResponseHandler.h>

Inheritance diagram for BESDelDefResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDelDefResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESDelDefResponseHandler (const string &name)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to delete a definition
virtual string get_name () const
 return the name of this response 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 void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object
virtual ~BESDelDefResponseHandler (void)

Static Public Member Functions

static BESResponseHandlerDelDefResponseBuilder (const string &name)

Protected Attributes

BESResponseObject_response
string _response_name

Detailed Description

response handler that deletes a definition from a specified definition store

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.


Constructor & Destructor Documentation

BESDelDefResponseHandler::BESDelDefResponseHandler ( const string &  name  ) 

Definition at line 45 of file BESDelDefResponseHandler.cc.

Referenced by DelDefResponseBuilder().

BESDelDefResponseHandler::~BESDelDefResponseHandler ( void   )  [virtual]

Definition at line 50 of file BESDelDefResponseHandler.cc.


Member Function Documentation

BESResponseHandler * BESDelDefResponseHandler::DelDefResponseBuilder ( const string &  name  )  [static]

Definition at line 158 of file BESDelDefResponseHandler.cc.

References BESDelDefResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

void BESDelDefResponseHandler::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 148 of file BESDelDefResponseHandler.cc.

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

Here is the call graph for this function:

void BESDelDefResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

executes the command to delete a definition

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:
dhi structure that holds request and response information
Exceptions:
BESSyntaxUserError if 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 BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESDataHandlerInterface::data, DEF_NAME, BESDefinitionStorage::del_definition(), DELETE_DEFINITION_STR, BESDefinitionStorageList::find_persistence(), PERSISTENCE_VOLATILE, STORE_NAME, and BESDefinitionStorageList::TheList().

Here is the call graph for this function:

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

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 CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

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.

void BESDelDefResponseHandler::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 129 of file BESDelDefResponseHandler.cc.

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

Here is the call graph for this function:


Member Data Documentation

BESResponseObject* BESResponseHandler::_response [protected, inherited]

Definition at line 85 of file BESResponseHandler.h.

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

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

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


The documentation for this class was generated from the following files:
Generated on Thu Feb 11 09:16:10 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7