BESXMLInterface Class Reference

Entry point into BES using xml document requests. More...

#include <BESXMLInterface.h>

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

List of all members.

Public Member Functions

 BESXMLInterface (const string &cmd, ostream *strm)
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 ~BESXMLInterface ()

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.
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 xml document requests.

See also:
BESInterface

Definition at line 52 of file BESXMLInterface.h.


Constructor & Destructor Documentation

BESXMLInterface::BESXMLInterface ( const string &  cmd,
ostream *  strm 
)
BESXMLInterface::~BESXMLInterface (  )  [virtual]

Definition at line 57 of file BESXMLInterface.cc.

References 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 BESXMLInterface::build_data_request_plan (  )  [protected, virtual]
void BESXMLInterface::clean (  )  [protected, virtual]

Clean up after the request is completed.

Reimplemented from BESBasicInterface.

Definition at line 341 of file BESXMLInterface.cc.

References BESInterface::_dhi, and BESXMLCommand::get_dhi().

Referenced by ~BESXMLInterface().

Here is the call graph for this function:

void BESXMLInterface::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 362 of file BESXMLInterface.cc.

References BESXMLCommand::dump(), 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 BESXMLInterface::execute_data_request_plan (  )  [protected, virtual]

Execute the data request plan.

Reimplemented from BESBasicInterface.

Definition at line 251 of file BESXMLInterface.cc.

References BESInterface::_dhi.

int BESXMLInterface::execute_request ( const string &  from  )  [virtual]

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

Definition at line 63 of file BESXMLInterface.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 BESXMLInterface::initialize (  )  [protected, virtual]

Initialize the BES.

Reimplemented from BESBasicInterface.

Definition at line 71 of file BESXMLInterface.cc.

void BESXMLInterface::invoke_aggregation (  )  [protected, virtual]

Invoke the aggregation server, if there is one.

Reimplemented from BESBasicInterface.

Definition at line 266 of file BESXMLInterface.cc.

void BESXMLInterface::log_status (  )  [protected, virtual]

Log the status of the request to the BESLog file.

See also:
BESLog

Reimplemented from BESBasicInterface.

Definition at line 300 of file BESXMLInterface.cc.

References BESInterface::_dhi.

void BESXMLInterface::report_request (  )  [protected, virtual]

Report the request and status of the request.

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.

Since there are multiple commands in an XML request document we iterate through the commands and execute report_request for each of the commands, giving the reporter a chance to report on each of the commands.

See also:
BESReporterList
BESReporter

Reimplemented from BESInterface.

Definition at line 327 of file BESXMLInterface.cc.

References BESInterface::_dhi.

void BESXMLInterface::transmit_data (  )  [protected, virtual]

Transmit the response object.

Reimplemented from BESBasicInterface.

Definition at line 274 of file BESXMLInterface.cc.

References BESInterface::_dhi, BESInterface::_transmitter, BESDEBUG, BESDataHandlerInterface::data, BESReturnManager::find_transmitter(), RETURN_CMD, and BESReturnManager::TheManager().

Here is the call graph for this function:

void BESXMLInterface::validate_data_request (  )  [protected, virtual]

Validate the incoming request information.

Reimplemented from BESBasicInterface.

Definition at line 79 of file BESXMLInterface.cc.


Member Data Documentation

BESTransmitter* BESInterface::_transmitter [protected, inherited]

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

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