#include <BESXMLInfo.h>
Inheritance diagram for BESXMLInfo:
Public Member Functions | |
BESXMLInfo () | |
constructs an html information response object. | |
virtual | ~BESXMLInfo () |
virtual void | begin_response (const string &response_name) |
begin the informational response | |
virtual void | end_response () |
end the response | |
virtual void | add_tag (const string &tag_name, const string &tag_data, map< string, string > *attrs=0) |
add tagged information to the inforamtional response | |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow | |
virtual void | end_tag (const string &tag_name) |
end a tagged part of the informational response | |
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. | |
virtual void | add_space (unsigned long num_spaces) |
add a space to the informational response | |
virtual void | add_break (unsigned long num_breaks) |
add a line break to the information | |
virtual void | add_data_from_file (const string &key, const string &name) |
add data from a file to the informational object | |
virtual void | print (ostream &strm) |
print the information from this informational object to the specified stream | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the text information as text | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | add_exception (BESException &e) |
add exception information to this informational object | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. | |
Static Public Member Functions | |
static BESInfo * | BuildXMLInfo (const string &info_type) |
Protected Attributes | |
ostream * | _strm |
bool | _strm_owned |
bool | _buffered |
bool | _response_started |
stack< string > | _tags |
string | _response_name |
An informational response object that is formated as an XML document.
BESXMLInfo::BESXMLInfo | ( | ) |
constructs an html information response object.
Uses the default BES.Info.Buffered key in the bes configuration file to determine whether the information should be buffered or not.
BESXMLInfo::~BESXMLInfo | ( | ) | [virtual] |
void BESXMLInfo::add_break | ( | unsigned long | num_breaks | ) | [virtual] |
add a line break to the information
num_breaks | the number of line breaks to add to the information |
Implements BESInfo.
void BESXMLInfo::add_data | ( | const string & | s | ) | [virtual] |
add data to this informational object. If buffering is not set then the information is output directly to the output stream.
s | information to be added to this informational response object |
Reimplemented from BESInfo.
void BESXMLInfo::add_data_from_file | ( | const string & | key, | |
const string & | name | |||
) | [virtual] |
add data from a file to the informational object
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.
void BESInfo::add_exception | ( | BESException & | e | ) | [virtual, inherited] |
add exception information to this informational object
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.
type | The type of exception being thrown | |
e | The exception to add to the informational response object |
Reimplemented in BESSilentInfo, and BESVersionInfo.
void BESXMLInfo::add_space | ( | unsigned long | num_spaces | ) | [virtual] |
add a space to the informational response
num_spaces | the number of spaces to add to the information |
Implements BESInfo.
void BESXMLInfo::add_tag | ( | const string & | tag_name, | |
const string & | tag_data, | |||
map< string, string > * | attrs = 0 | |||
) | [virtual] |
add tagged information to the inforamtional response
tag_name | name of the tag to be added to the response | |
tag_data | information describing the tag |
Implements BESInfo.
void BESXMLInfo::begin_response | ( | const string & | response_name | ) | [virtual] |
begin the informational response
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 |
Reimplemented from BESInfo.
void BESXMLInfo::begin_tag | ( | const string & | tag_name, | |
map< string, string > * | attrs = 0 | |||
) | [virtual] |
begin a tagged part of the information, information to follow
tag_name | name of the tag to begin |
Reimplemented from BESInfo.
BESInfo * BESXMLInfo::BuildXMLInfo | ( | const string & | info_type | ) | [static] |
void BESXMLInfo::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
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.
void BESXMLInfo::end_response | ( | ) | [virtual] |
end the response
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.
void BESXMLInfo::end_tag | ( | const string & | tag_name | ) | [virtual] |
end a tagged part of the informational response
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.
virtual bool BESInfo::is_buffered | ( | ) | [inline, virtual, inherited] |
return whether the information is to be buffered or not.
void BESXMLInfo::print | ( | ostream & | strm | ) | [virtual] |
print the information from this informational object to the specified stream
strm | output to this stream |
Reimplemented from BESInfo.
void BESXMLInfo::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the text information as text
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.
bool BESInfo::_buffered [protected, inherited] |
string BESInfo::_response_name [protected, inherited] |
bool BESInfo::_response_started [protected, inherited] |
ostream* BESInfo::_strm [protected, inherited] |
bool BESInfo::_strm_owned [protected, inherited] |
stack<string> BESInfo::_tags [protected, inherited] |