BESSetContainerResponseHandler Class Reference

response handler that creates a container given the symbolic name, real name, and data type. More...

#include <BESSetContainerResponseHandler.h>

Inheritance diagram for BESSetContainerResponseHandler:
Inheritance graph
[legend]
Collaboration diagram for BESSetContainerResponseHandler:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESSetContainerResponseHandler (const string &name)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to create a new container or replaces an already existing container based on the provided symbolic name.
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 ~BESSetContainerResponseHandler (void)

Static Public Member Functions

static BESResponseHandlerSetContainerResponseBuilder (const string &name)

Protected Attributes

BESResponseObject_response
string _response_name

Detailed Description

response handler that creates a container given the symbolic name, real name, and data type.

This request handler creates a new container, or replaces an already existing container in the specified container storage given the symbolic name, real name (in most cases a file name), and the type of data represented by the real name (e.g. netcdf, cedar, cdf, hdf, etc...) The request has the syntax:

set container in <store_name> values <sym_name>,<real_name>,<data_type>;

It returns whether the container was created or replaces successfully in an informational response object and transmits that response object.

See also:
BESResponseObject
BESContainer
BESTransmitter

Definition at line 56 of file BESSetContainerResponseHandler.h.


Constructor & Destructor Documentation

BESSetContainerResponseHandler::BESSetContainerResponseHandler ( const string &  name  ) 

Definition at line 41 of file BESSetContainerResponseHandler.cc.

Referenced by SetContainerResponseBuilder().

BESSetContainerResponseHandler::~BESSetContainerResponseHandler ( void   )  [virtual]

Definition at line 46 of file BESSetContainerResponseHandler.cc.


Member Function Documentation

void BESSetContainerResponseHandler::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 143 of file BESSetContainerResponseHandler.cc.

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

Here is the call graph for this function:

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

executes the command to create a new container or replaces an already existing container based on the provided symbolic name.

The symbolic name is first looked up in the specified container storage object, volatile if no container storage name is specified. If the symbolic name already exists (the container already exists) then the already existing container is removed and the new one added using the given real name (usually a file name) and the type of data represented by this container (e.g. cedar, cdf, netcdf, hdf, etc...)

An informational response object BESInfo is created to hold whether or not the container was successfully added/replaced. Possible responses are:

Successfully added container "&lt;sym_name&gt;" in container storage "&lt;store_name&gt;"

Successfully replaced container "&lt;sym_name&gt;" in container storage "&lt;store_name&gt;"

Unable to add container "&lt;sym_name&gt;" to container storage "&lt;store_name&gt;"

Unable to add container "&lt;sym_name&gt;" to container storage "&lt;store_name&gt;"

Container storage "&lt;store_name&gt;" does not exist

Parameters:
dhi structure that holds request and response information
Exceptions:
BESSyntaxUserError if the specified store name does not exist
See also:
BESDataHandlerInterface
BESInfo
BESContainerStorageList
BESContainerStorage
BESContainer

Implements BESResponseHandler.

Definition at line 85 of file BESSetContainerResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESContainerStorage::add_container(), CONTAINER_TYPE, BESDataHandlerInterface::data, BESContainerStorage::del_container(), BESContainerStorageList::find_persistence(), REAL_NAME, SETCONTAINER_STR, STORE_NAME, SYMBOLIC_NAME, and BESContainerStorageList::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]
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.

BESResponseHandler * BESSetContainerResponseHandler::SetContainerResponseBuilder ( const string &  name  )  [static]

Definition at line 153 of file BESSetContainerResponseHandler.cc.

References BESSetContainerResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

void BESSetContainerResponseHandler::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 124 of file BESSetContainerResponseHandler.cc.

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

Here is the call graph for this function:


Member Data Documentation

Definition at line 85 of file BESResponseHandler.h.

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

string BESResponseHandler::_response_name [protected, inherited]

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

Generated on 27 Oct 2009 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.6.1