BESCmdInterface Class Reference

Entry point into BES using string command requests. More...

#include <BESCmdInterface.h>

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

List of all members.

Public Member Functions

 BESCmdInterface (const string &cmd, ostream *strm)
 Instantiate the BESCmdInterface object given the string command and the output stream to use for the response object.
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int execute_request (const string &from)
 Override execute_request in order to register memory pool.
virtual int finish_with_error (int status)
virtual ~BESCmdInterface ()

Static Public Member Functions

static void add_end_callback (p_bes_end end)
static void add_init_callback (p_bes_init init)

Protected Member Functions

virtual void build_data_request_plan ()
 Build the data request plan using the BESCmdParser.
virtual void clean ()
 Clean up after the request is completed.
virtual void end_request ()
 End the BES request.
virtual int exception_manager (BESError &e)
 Manage any exceptions thrown during the whole process.
virtual void execute_data_request_plan ()
 Execute the data request plan.
virtual int finish (int status)
virtual void initialize ()
 Initialize the BES.
virtual void invoke_aggregation ()
 Invoke the aggregation server, if there is one.
virtual void log_status ()
 Log the status of the request to the BESLog file.
virtual void report_request ()
 Report the request and status of the request to BESReporterList::TheList().
virtual void transmit_data ()
 Transmit the response object.
virtual void validate_data_request ()
 Validate the incoming request information.

Protected Attributes

BESDataHandlerInterface_dhi
BESTransmitter_transmitter

Detailed Description

Entry point into BES using string command requests.

The format of the request looks somethink like:

    set container in catalog values c,nc/mplot.nc;
    define d as c;
    get das for d;
    

In this example a DAS object response is being requested. The DAS object is to be built from the definition 'd', where d is defined using the data container c. The data container c is created using the real file nc/mplot.nc

BESCmdInterface uses BESParser to parse through the request string, building up a plan to be used during the execute method. Most implementations simply log information to the BESLog file before calling the parent class method.

See also:
BESInterface
BESParser

Definition at line 61 of file BESCmdInterface.h.


Constructor & Destructor Documentation

BESCmdInterface::BESCmdInterface ( const string &  cmd,
ostream *  strm 
)

Instantiate the BESCmdInterface object given the string command and the output stream to use for the response object.

Parameters:
cmd BES string command
strm Ouput stream used to output the response object

Definition at line 58 of file BESCmdInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::data, and DATA_REQUEST.

BESCmdInterface::~BESCmdInterface (  )  [virtual]

Definition at line 65 of file BESCmdInterface.cc.

References BESBasicInterface::clean().

Here is the call graph for this function:


Member Function Documentation

void BESInterface::add_end_callback ( p_bes_end  end  )  [static, inherited]

Definition at line 464 of file BESInterface.cc.

void BESInterface::add_init_callback ( p_bes_init  init  )  [static, inherited]

Definition at line 282 of file BESInterface.cc.

void BESCmdInterface::build_data_request_plan (  )  [protected, virtual]

Build the data request plan using the BESCmdParser.

See also:
BESCmdParser

Reimplemented from BESBasicInterface.

Definition at line 75 of file BESCmdInterface.cc.

References BESInterface::_dhi, BESDEBUG, BESDataHandlerInterface::data, DATA_REQUEST, BESCmdParser::parse(), REQUEST_FROM, SERVER_PID, BESLog::TheLog(), and BESUtil::www2id().

Here is the call graph for this function:

void BESBasicInterface::clean (  )  [protected, virtual, inherited]

Clean up after the request is completed.

Calls the parent method clean and then logs to the BESLog file saying that we are done and exiting the process. The exit actually takes place in the module code.

See also:
BESLog

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 289 of file BESBasicInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::data, DATA_REQUEST, REQUEST_FROM, SERVER_PID, and BESLog::TheLog().

Referenced by BESApacheInterface::~BESApacheInterface(), and ~BESCmdInterface().

Here is the call graph for this function:

void BESCmdInterface::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 BESBasicInterface.

Definition at line 108 of file BESCmdInterface.cc.

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

Here is the call graph for this function:

void BESInterface::end_request (  )  [protected, virtual, inherited]

End the BES request.

This method allows developers to add callbacks at the end of a request, to do any cleanup or do any extra work at the end of a request

Definition at line 475 of file BESInterface.cc.

References BESInterface::_dhi, BESDEBUG, BESDataHandlerInterface::container, BESDataHandlerInterface::data, DATA_REQUEST, BESDataHandlerInterface::first_container(), BESDataHandlerInterface::next_container(), and BESContainer::release().

Referenced by BESInterface::finish().

Here is the call graph for this function:

int BESInterface::exception_manager ( BESError e  )  [protected, virtual, inherited]

Manage any exceptions thrown during the whole process.

Specific responses are generated given a specific Exception caught. If additional exceptions are thrown within derived systems then implement those in the derived exception_manager methods. This is a catch-all manager and should be called once derived methods have caught their exceptions.

Parameters:
e BESError to be managed
Returns:
status after exception is handled
See also:
BESError

Reimplemented in BESApacheInterface.

Definition at line 519 of file BESInterface.cc.

References BESInterface::_dhi, BESExceptionManager::handle_exception(), and BESExceptionManager::TheEHM().

Referenced by BESInterface::execute_request(), BESInterface::finish(), and BESInterface::finish_with_error().

Here is the call graph for this function:

void BESBasicInterface::execute_data_request_plan (  )  [protected, virtual, inherited]

Execute the data request plan.

Simply calls the parent method. Prior to calling the parent method logs a message to the dods log file.

See also:
BESLog

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 180 of file BESBasicInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::data, DATA_REQUEST, REQUEST_FROM, SERVER_PID, and BESLog::TheLog().

Here is the call graph for this function:

int BESBasicInterface::execute_request ( const string &  from  )  [virtual, inherited]

Override execute_request in order to register memory pool.

Once the memory pool is initialized hand over control to parent class to execute the request. Once completed, unregister the memory pool.

This needs to be done here instead of the initialization method because???

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 76 of file BESBasicInterface.cc.

int BESInterface::finish ( int  status  )  [protected, virtual, inherited]
int BESInterface::finish_with_error ( int  status  )  [virtual, inherited]

Definition at line 268 of file BESInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::error_info, BESInterface::exception_manager(), and BESInterface::finish().

Referenced by BESApacheWrapper::call_BES().

Here is the call graph for this function:

void BESBasicInterface::initialize (  )  [protected, virtual, inherited]

Initialize the BES.

Determines what transmitter this BES will be using to transmit response objects and then calls the parent initialization method in order to initialize all global variables.

See also:
BESTransmitter
BESDataHandlerInterface

Reimplemented from BESInterface.

Reimplemented in BESApacheInterface, and BESXMLInterface.

Definition at line 91 of file BESBasicInterface.cc.

References BESInterface::_dhi, BESInterface::_transmitter, BASIC_TRANSMITTER, BESDEBUG, BESReturnManager::find_transmitter(), HTTP_TRANSMITTER, BESReturnManager::TheManager(), and BESDataHandlerInterface::transmit_protocol.

Here is the call graph for this function:

void BESBasicInterface::invoke_aggregation (  )  [protected, virtual, inherited]

Invoke the aggregation server, if there is one.

Simply calls the parent method. Prior to calling the parent method logs a message to the dods log file.

See also:
BESLog

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 200 of file BESBasicInterface.cc.

References BESInterface::_dhi, AGG_CMD, AGG_HANDLER, BESDataHandlerInterface::data, DATA_REQUEST, BESAggFactory::find_handler(), BESLog::is_verbose(), REQUEST_FROM, SERVER_PID, BESAggFactory::TheFactory(), and BESLog::TheLog().

Here is the call graph for this function:

void BESBasicInterface::log_status (  )  [protected, virtual, inherited]

Log the status of the request to the BESLog file.

See also:
BESLog

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 266 of file BESBasicInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::data, DATA_REQUEST, BESDataHandlerInterface::error_info, REQUEST_FROM, SERVER_PID, and BESLog::TheLog().

Here is the call graph for this function:

void BESInterface::report_request (  )  [protected, virtual, inherited]

Report the request and status of the request to BESReporterList::TheList().

If interested in reporting the request and status of the request then one must register a BESReporter with BESReporterList::TheList().

If no BESReporter objects are registered then nothing happens.

See also:
BESReporterList
BESReporter

Reimplemented in BESXMLInterface.

Definition at line 453 of file BESInterface.cc.

References BESInterface::_dhi, BESDEBUG, BESDataHandlerInterface::data, DATA_REQUEST, BESReporterList::report(), and BESReporterList::TheList().

Referenced by BESInterface::finish().

Here is the call graph for this function:

void BESBasicInterface::transmit_data (  )  [protected, virtual, inherited]

Transmit the response object.

Simply calls the parent method. Prior to calling the parent method logs a message to the dods log file.

See also:
BESLog

Reimplemented from BESInterface.

Reimplemented in BESXMLInterface.

Definition at line 249 of file BESBasicInterface.cc.

References BESInterface::_dhi, BESDataHandlerInterface::data, DATA_REQUEST, REQUEST_FROM, SERVER_PID, and BESLog::TheLog().

Here is the call graph for this function:

void BESBasicInterface::validate_data_request (  )  [protected, virtual, inherited]

Validate the incoming request information.

Reimplemented from BESInterface.

Reimplemented in BESApacheInterface, and BESXMLInterface.

Definition at line 135 of file BESBasicInterface.cc.


Member Data Documentation

BESTransmitter* BESInterface::_transmitter [protected, inherited]

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

Generated on 19 Feb 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.6.1