bes
Updated for version 3.17.4
|
represents an xml formatted response object More...
#include <BESXMLInfo.h>
Public Member Functions | |
virtual void | add_break (unsigned long num_breaks) |
add a line break to the information More... | |
virtual void | add_data (const string &s) |
add data to this informational object. If buffering is not set then the information is output directly to the output stream. More... | |
virtual void | add_data_from_file (const string &key, const string &name) |
add data from a file to the informational object More... | |
virtual void | add_exception (BESError &e, const string &admin) |
add exception information to this informational object More... | |
virtual void | add_space (unsigned long num_spaces) |
add a space to the informational response More... | |
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
add tagged information to the inforamtional response More... | |
virtual void | begin_response (const string &response_name, BESDataHandlerInterface &dhi) |
begin the informational response More... | |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow More... | |
BESXMLInfo () | |
constructs an informational response object as an xml document More... | |
virtual void | dump (ostream &strm) const |
dumps information about this object More... | |
virtual void | end_response () |
end the response More... | |
virtual void | end_tag (const string &tag_name) |
end a tagged part of the informational response More... | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. More... | |
virtual void | print (ostream &strm) |
print the information from this informational object to the specified stream More... | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the text information as text More... | |
Static Public Member Functions | |
static BESInfo * | BuildXMLInfo (const string &info_type) |
Protected Member Functions | |
virtual void | begin_tag (const string &tag_name, const string &ns, const string &uri, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow More... | |
Protected Attributes | |
bool | _buffered |
string | _response_name |
bool | _response_started |
ostream * | _strm |
bool | _strm_owned |
stack< string > | _tags |
An informational response object that is formated as an XML document.
Definition at line 48 of file BESXMLInfo.h.
BESXMLInfo::BESXMLInfo | ( | ) |
Definition at line 49 of file BESXMLInfo.cc.
|
virtual |
num_breaks | the number of line breaks to add to the information |
Implements BESInfo.
Definition at line 476 of file BESXMLInfo.cc.
References BESInfo::add_data().
|
virtual |
s | information to be added to this informational response object |
Reimplemented from BESInfo.
Definition at line 487 of file BESXMLInfo.cc.
References BESInfo::add_data().
|
virtual |
This method simply adds a .XML to the end of the key and passes the request on up to the BESInfo parent class.
key | Key from the initialization file specifying the file to be |
name | A description of what is the information being loaded |
Reimplemented from BESInfo.
Definition at line 501 of file BESXMLInfo.cc.
References BESInfo::add_data_from_file(), begin_tag(), and end_tag().
|
virtualinherited |
Exception information is added differently to different informational objects, such as html, xml, plain text. But, using the other methods of this class we can take care of exceptions here.
e | The exception to add to the informational response object |
admin | The contact information for the person responsible for this error |
Reimplemented in BESVersionInfo, BESDapErrorInfo, and BESSilentInfo.
Definition at line 222 of file BESInfo.cc.
References BESError::get_error_type(), BESError::get_file(), BESError::get_line(), and BESError::get_message().
|
virtual |
num_spaces | the number of spaces to add to the information |
Implements BESInfo.
Definition at line 461 of file BESXMLInfo.cc.
References BESInfo::add_data().
|
virtual |
tag_name | name of the tag to be added to the response |
tag_data | information describing the tag |
attrs | map of attributes to add to the tag |
Implements BESInfo.
Definition at line 275 of file BESXMLInfo.cc.
|
virtual |
This will add the response name as well as the <response> tag tot he informational response object
response_name | name of the response this information represents |
dhi | information about the request and response |
Reimplemented from BESInfo.
Definition at line 99 of file BESXMLInfo.cc.
References BESInfo::begin_response(), and BESDataHandlerInterface::data.
|
protectedvirtual |
tag_name | name of the tag to begin |
ns | namespace name to include in the tag |
uri | namespace uri |
attrs | map of attributes to begin the tag with |
Definition at line 356 of file BESXMLInfo.cc.
|
virtual |
tag_name | name of the tag to begin |
attrs | map of attributes to begin the tag with |
Reimplemented from BESInfo.
Definition at line 342 of file BESXMLInfo.cc.
References begin_tag().
|
virtual |
Displays the pointer value of this instance along with information about this XML informational object.
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
Definition at line 555 of file BESXMLInfo.cc.
References BESXMLInfo(), and BESInfo::dump().
|
virtual |
Add the terminating tags for the response and for the response name. If there are still tags that have not been closed then an exception is thrown.
Reimplemented from BESInfo.
Definition at line 211 of file BESXMLInfo.cc.
|
virtual |
If the named tag is not the current tag then an error is thrown.
tag_name | name of the tag to end |
Reimplemented from BESInfo.
Definition at line 423 of file BESXMLInfo.cc.
|
inlinevirtualinherited |
Definition at line 123 of file BESInfo.h.
References BESInfo::dump().
|
virtual |
strm | output to this stream |
Reimplemented from BESInfo.
Definition at line 538 of file BESXMLInfo.cc.
References end_response().
|
virtual |
use the send_text method on the transmitter to transmit the information back to the client.
transmitter | The type of transmitter to use to transmit the info |
dhi | information to help with the transmission |
Implements BESInfo.
Definition at line 522 of file BESXMLInfo.cc.
References end_response().