bes
Updated for version 3.19.1
|
Public Member Functions | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual BESDataHandlerInterface & | get_xmlcmd_dhi () |
Return the current BESDataHandlerInterface. More... | |
virtual bool | has_response ()=0 |
Has a response handler been created given the request document? More... | |
virtual void | parse_request (xmlNode *node)=0 |
Parse the XML request document beginning at the given node. More... | |
virtual void | prep_request () |
Prepare any information needed to execute the request of this command. More... | |
Static Public Member Functions | |
static void | add_command (const std::string &cmd_str, p_xmlcmd_builder cmd) |
Add a command to the possible commands allowed by this BES. More... | |
static bool | del_command (const std::string &cmd_str) |
Deletes the command called cmd_str from the list of possible commands. More... | |
static p_xmlcmd_builder | find_command (const std::string &cmd_str) |
Find the BESXMLCommand creation function with the given name. More... | |
Protected Member Functions | |
BESXMLCommand (const BESDataHandlerInterface &base_dhi) | |
Creates a BESXMLCommand document given a base data handler interface object. More... | |
virtual void | set_response () |
The request has been parsed, use the command action name to set the response handler. More... | |
Protected Attributes | |
std::string | d_cmd_log_info |
Used only for the log. More... | |
BESDataHandlerInterface | d_xmlcmd_dhi |
Definition at line 51 of file BESXMLCommand.h.
|
protected |
Creates a BESXMLCommand document given a base data handler interface object.
Since there can be multiple commands within a single BES request document, there can be multiple data handler interface objects created. Use the one passed as the base interface handler object
Definition at line 52 of file BESXMLCommand.cc.
|
static |
Add a command to the possible commands allowed by this BES.
This adds a function to parse a specific BES command within the BES request document using the given name. If a command element is found with the name cmd_str, then the XMLCommand object is created using the passed cmd object.
cmd_str | The name of the command |
cmd | The function to call to create the BESXMLCommand object |
Definition at line 84 of file BESXMLCommand.cc.
|
static |
Deletes the command called cmd_str from the list of possible commands.
cmd_str | The name of the command to remove from the list |
Definition at line 94 of file BESXMLCommand.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Implements BESObj.
Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, SampleSayXMLCommand, BESXMLCatalogCommand, BESXMLDeleteContainerCommand, BESXMLDeleteContainersCommand, BESXMLDeleteDefinitionCommand, BESXMLDeleteDefinitionsCommand, BESXMLSetContainerCommand, BESXMLSetContextCommand, BESXMLShowCommand, and BESXMLShowErrorCommand.
Definition at line 120 of file BESXMLCommand.cc.
|
static |
Find the BESXMLCommand creation function with the given name.
cmd_str | The name of the command creation function to find |
Definition at line 109 of file BESXMLCommand.cc.
|
inlinevirtual |
Return the current BESDataHandlerInterface.
Since there can be multiple commands within a single request document, different interface objects can be created. This returns the current interface object
Reimplemented in BESXMLGetCommand.
Definition at line 103 of file BESXMLCommand.h.
|
pure virtual |
Has a response handler been created given the request document?
Implemented in BESXMLDefineCommand, BESXMLGetCommand, SampleSayXMLCommand, BESXMLCatalogCommand, BESXMLDeleteContainerCommand, BESXMLDeleteContainersCommand, BESXMLDeleteDefinitionCommand, BESXMLDeleteDefinitionsCommand, BESXMLSetContainerCommand, BESXMLSetContextCommand, BESXMLShowCommand, and BESXMLShowErrorCommand.
|
pure virtual |
Parse the XML request document beginning at the given node.
node | Begin parsing at this XML node |
Implemented in BESXMLDefineCommand, BESXMLGetCommand, SampleSayXMLCommand, BESXMLCatalogCommand, BESXMLDeleteContainerCommand, BESXMLDeleteContainersCommand, BESXMLDeleteDefinitionCommand, BESXMLDeleteDefinitionsCommand, BESXMLSetContainerCommand, BESXMLSetContextCommand, BESXMLShowCommand, and BESXMLShowErrorCommand.
|
inlinevirtual |
Prepare any information needed to execute the request of this command.
Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, and SampleSayXMLCommand.
Definition at line 90 of file BESXMLCommand.h.
|
protectedvirtual |
The request has been parsed, use the command action name to set the response handler.
Definition at line 60 of file BESXMLCommand.cc.
|
protected |
Used only for the log.
Definition at line 62 of file BESXMLCommand.h.