bes
Updated for version 3.19.1
|
Entry point into BES using xml document requests. More...
#include <BESXMLInterface.h>
Public Member Functions | |
BESXMLInterface (const std::string &cmd, std::ostream *strm) | |
virtual void | dump (std::ostream &strm) const |
dumps information about this object More... | |
virtual int | execute_request (const string &from) |
The entry point for command execution; called by BESServerHandler::execute() More... | |
virtual int | finish_with_error (int status) |
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 void | finish () |
virtual void | log_status () |
Log the status of the request to the BESLog file. More... | |
virtual void | transmit_data () |
Transmit the response object. More... | |
Protected Attributes | |
BESDataHandlerInterface * | d_dhi_ptr |
Allocated by the child class. More... | |
BESTransmitter * | d_transmitter |
The Transmitter to use for the result. More... | |
Entry point into BES using xml document requests.
Definition at line 47 of file BESXMLInterface.h.
|
protectedvirtual |
Build the data request plan using the BESCmdParser.
Implements BESInterface.
Definition at line 71 of file BESXMLInterface.cc.
|
protectedvirtual |
Clean up after the request is completed.
Implements BESInterface.
Definition at line 342 of file BESXMLInterface.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInterface.
Definition at line 369 of file BESXMLInterface.cc.
|
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 465 of file BESInterface.cc.
|
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.
e | BESError to be managed |
Definition at line 488 of file BESInterface.cc.
|
protectedvirtual |
Execute the data request plan.
Implements BESInterface.
Definition at line 216 of file BESXMLInterface.cc.
|
virtualinherited |
The entry point for command execution; called by BESServerHandler::execute()
Execute the request by:
If an exception is thrown in any of these steps the exception is handed over to the exception manager in order to generate the proper response. Control is returned back to the calling method if an exception is thrown and it is the responsibility of the calling method to call finish_with_error in order to transmit the error message back to the client.
from | A string that tells where this request came from. Literally, the IP and port number or the string 'standalone'. See void BESServerHandler::execute(Connection *c) or void StandAloneClient::executeCommand(const string & cmd, int repeat) |
Definition at line 285 of file BESInterface.cc.
|
protectedvirtual |
Log the status of the request to the BESLog file.
This will only log information in the verbose mode.
Implements BESInterface.
Definition at line 322 of file BESXMLInterface.cc.
|
protectedvirtual |
Transmit the response object.
Only transmit if there is an error or if there is a ResponseHandler. For any XML document with one or more commands, there should only be one ResponseHandler.
Implements BESInterface.
Definition at line 287 of file BESXMLInterface.cc.
|
protectedinherited |
Allocated by the child class.
Definition at line 121 of file BESInterface.h.
|
protectedinherited |
The Transmitter to use for the result.
Definition at line 122 of file BESInterface.h.