bes
Updated for version 3.17.4
|
Entry point into BES using xml document requests. More...
#include <BESXMLInterface.h>
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) |
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. 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. | |
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. More... | |
virtual void | report_request () |
Report the request and status of the request. More... | |
virtual void | transmit_data () |
Transmit the response object. | |
virtual void | validate_data_request () |
Validate the incoming request information. | |
Protected Attributes | |
BESDataHandlerInterface * | _dhi |
BESTransmitter * | _transmitter |
Definition at line 52 of file BESXMLInterface.h.
|
virtual |
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESBasicInterface.
Definition at line 342 of file BESXMLInterface.cc.
References BESBasicInterface::dump(), and BESXMLCommand::dump().
|
protectedvirtualinherited |
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 706 of file BESInterface.cc.
References BESDataHandlerInterface::container, BESDataHandlerInterface::data, BESDataHandlerInterface::first_container(), and BESDataHandlerInterface::next_container().
|
protectedvirtualinherited |
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.
e | BESError to be managed |
Definition at line 746 of file BESInterface.cc.
References BESExceptionManager::handle_exception().
|
virtual |
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 66 of file BESXMLInterface.cc.
References BESBasicInterface::execute_request().
|
protectedvirtual |
Reimplemented from BESBasicInterface.
Definition at line 286 of file BESXMLInterface.cc.
References BESBasicInterface::log_status().
|
protectedvirtual |
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.
Reimplemented from BESInterface.
Definition at line 311 of file BESXMLInterface.cc.
References BESInterface::report_request().