OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESXMLInterface Class Reference

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

#include <BESXMLInterface.h>

Inheritance diagram for BESXMLInterface:
Inheritance graph
Collaboration diagram for BESXMLInterface:
Collaboration graph

Public Member Functions

 BESXMLInterface (const string &cmd, ostream *strm)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual int execute_request (const string &from)
 Override execute_request in order to register memory pool. More...
 
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. More...
 
virtual void clean ()
 Clean up after the request is completed. More...
 
virtual void end_request ()
 End the BES request. More...
 
virtual int exception_manager (BESError &e)
 Manage any exceptions thrown during the whole process. More...
 
virtual void execute_data_request_plan ()
 Execute the data request plan. More...
 
virtual int finish (int status)
 
virtual void initialize ()
 Initialize the BES. More...
 
virtual void invoke_aggregation ()
 Invoke the aggregation server, if there is one. More...
 
virtual void log_status ()
 Log the status of the request to the BESLog file. More...
 
virtual void report_request ()
 Report the request and status of the request. More...
 
virtual void transmit_data ()
 Transmit the response object. More...
 
virtual void validate_data_request ()
 Validate the incoming request information. More...
 

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)
staticinherited

Definition at line 467 of file BESInterface.cc.

void BESInterface::add_init_callback ( p_bes_init  init)
staticinherited

Definition at line 281 of file BESInterface.cc.

void BESXMLInterface::clean ( )
protectedvirtual

Clean up after the request is completed.

Reimplemented from BESBasicInterface.

Definition at line 347 of file BESXMLInterface.cc.

References BESInterface::_dhi, BESBasicInterface::clean(), 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
strmC++ i/o stream to dump the information to

Reimplemented from BESBasicInterface.

Definition at line 368 of file BESXMLInterface.cc.

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

Here is the call graph for this function:

void BESInterface::end_request ( )
protectedvirtualinherited

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 478 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)
protectedvirtualinherited

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
eBESError to be managed
Returns
status after exception is handled
See Also
BESError

Definition at line 522 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 ( )
protectedvirtual

Execute the data request plan.

Reimplemented from BESBasicInterface.

Definition at line 257 of file BESXMLInterface.cc.

References BESInterface::_dhi, and BESBasicInterface::execute_data_request_plan().

Here is the call graph for this function:

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.

References BESBasicInterface::execute_request().

Here is the call graph for this function:

int BESInterface::finish_with_error ( int  status)
virtualinherited

Definition at line 267 of file BESInterface.cc.

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

Here is the call graph for this function:

void BESXMLInterface::initialize ( )
protectedvirtual

Initialize the BES.

Reimplemented from BESBasicInterface.

Definition at line 71 of file BESXMLInterface.cc.

References BESBasicInterface::initialize().

Here is the call graph for this function:

void BESXMLInterface::invoke_aggregation ( )
protectedvirtual

Invoke the aggregation server, if there is one.

Reimplemented from BESBasicInterface.

Definition at line 272 of file BESXMLInterface.cc.

References BESBasicInterface::invoke_aggregation().

Here is the call graph for this function:

void BESXMLInterface::log_status ( )
protectedvirtual

Log the status of the request to the BESLog file.

See Also
BESLog

Reimplemented from BESBasicInterface.

Definition at line 306 of file BESXMLInterface.cc.

References BESInterface::_dhi, and BESBasicInterface::log_status().

Here is the call graph for this function:

void BESXMLInterface::report_request ( )
protectedvirtual

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 333 of file BESXMLInterface.cc.

References BESInterface::_dhi, and BESInterface::report_request().

Here is the call graph for this function:

void BESXMLInterface::transmit_data ( )
protectedvirtual

Transmit the response object.

Reimplemented from BESBasicInterface.

Definition at line 280 of file BESXMLInterface.cc.

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

Here is the call graph for this function:

void BESXMLInterface::validate_data_request ( )
protectedvirtual

Validate the incoming request information.

Reimplemented from BESBasicInterface.

Definition at line 79 of file BESXMLInterface.cc.

References BESBasicInterface::validate_data_request().

Here is the call graph for this function:

Member Data Documentation


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