represents an html formatted response object More...
#include <BESHTMLInfo.h>
Public Member Functions | |
virtual void | add_break (unsigned long num_breaks) |
add a line break to the information | |
virtual void | add_data (const string &s) |
add data to this informational object. | |
virtual void | add_data_from_file (const string &key, const string &name) |
add data from a file to the informational object | |
virtual void | add_exception (BESError &e, const string &admin) |
add exception information to this informational object | |
virtual void | add_space (unsigned long num_spaces) |
add a space to the informational 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_response (const string &response_name, BESDataHandlerInterface &dhi) |
begin the informational response | |
virtual void | begin_tag (const string &tag_name, map< string, string > *attrs=0) |
begin a tagged part of the information, information to follow | |
BESHTMLInfo () | |
constructs an html formatted information response object. | |
BESHTMLInfo (const string &key, ostream *strm, bool strm_owned) | |
constructs a basic text information response object. | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | end_response () |
end the response | |
virtual void | end_tag (const string &tag_name) |
end a tagged part of the informational response | |
virtual bool | is_buffered () |
return whether the information is to be buffered or not. | |
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 | ~BESHTMLInfo () |
Static Public Member Functions | |
static BESInfo * | BuildHTMLInfo (const string &info_type) |
Protected Attributes | |
bool | _buffered |
string | _response_name |
bool | _response_started |
ostream * | _strm |
bool | _strm_owned |
stack< string > | _tags |
represents an html formatted response object
Uses the default add_data method, but overwrites print method in order to set the mime type to html.
Definition at line 46 of file BESHTMLInfo.h.
BESHTMLInfo::BESHTMLInfo | ( | ) |
constructs an html formatted information response object.
Definition at line 50 of file BESHTMLInfo.cc.
Referenced by BuildHTMLInfo().
BESHTMLInfo::BESHTMLInfo | ( | const string & | key, | |
ostream * | strm, | |||
bool | strm_owned | |||
) |
constructs a basic text information response object.
Uses the default specified key in the bes configuration file to determine whether the information should be buffered or not.
Definition at line 65 of file BESHTMLInfo.cc.
BESHTMLInfo::~BESHTMLInfo | ( | ) | [virtual] |
Definition at line 72 of file BESHTMLInfo.cc.
void BESHTMLInfo::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.
Definition at line 205 of file BESHTMLInfo.cc.
References add_data().
void BESHTMLInfo::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.
Formatting is up to the user
s | information to be added to this response object |
Reimplemented from BESInfo.
Definition at line 227 of file BESHTMLInfo.cc.
References BESInfo::_buffered, BESInfo::_strm, and BESUtil::set_mime_html().
Referenced by add_break(), add_space(), add_tag(), begin_response(), begin_tag(), and end_response().
void BESHTMLInfo::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 .HTML 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 250 of file BESHTMLInfo.cc.
void BESInfo::add_exception | ( | BESError & | e, | |
const string & | admin | |||
) | [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.
e | The exception to add to the informational response object | |
admin | The contact information for the person responsible for this error |
Reimplemented in BESDapErrorInfo, BESSilentInfo, and BESVersionInfo.
Definition at line 255 of file BESInfo.cc.
References BESInfo::add_tag(), BESInfo::begin_tag(), BESInfo::end_tag(), BESError::get_error_type(), BESError::get_file(), BESError::get_line(), and BESError::get_message().
Referenced by BESVersionInfo::add_exception(), and BESExceptionManager::handle_exception().
void BESHTMLInfo::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.
Definition at line 189 of file BESHTMLInfo.cc.
References add_data().
void BESHTMLInfo::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 | |
attrs | map of attributes to add to the tag |
Implements BESInfo.
Definition at line 125 of file BESHTMLInfo.cc.
References add_data().
void BESHTMLInfo::begin_response | ( | const string & | response_name, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
begin the informational response
Because this is text informational object, no begin tags are needed
response_name | name of the response this information represents | |
dhi | information about the request and response |
Reimplemented from BESInfo.
Definition at line 84 of file BESHTMLInfo.cc.
References add_data().
void BESHTMLInfo::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 | |
attrs | map of attributes to begin the tag with |
Reimplemented from BESInfo.
Definition at line 150 of file BESHTMLInfo.cc.
References add_data().
BESInfo * BESHTMLInfo::BuildHTMLInfo | ( | const string & | info_type | ) | [static] |
Definition at line 292 of file BESHTMLInfo.cc.
References BESHTMLInfo().
Referenced by BESDefaultModule::initialize().
void BESHTMLInfo::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with values of private data members.
strm | C++ i/o stream to dump the information to |
Reimplemented from BESInfo.
Definition at line 279 of file BESHTMLInfo.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void BESHTMLInfo::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.
Definition at line 108 of file BESHTMLInfo.cc.
References add_data().
void BESHTMLInfo::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.
Definition at line 177 of file BESHTMLInfo.cc.
virtual bool BESInfo::is_buffered | ( | ) | [inline, virtual, inherited] |
return whether the information is to be buffered or not.
Definition at line 123 of file BESInfo.h.
References BESInfo::_buffered.
Referenced by BESBasicTransmitter::send_html(), BESBasicHttpTransmitter::send_html(), BESBasicTransmitter::send_text(), and BESBasicHttpTransmitter::send_text().
void BESInfo::print | ( | ostream & | strm | ) | [virtual, inherited] |
print the information from this informational object to the specified stream
If the information was not buffered then this method does nothing, otherwise the information is output to the specified ostream.
strm | output to this file descriptor if information buffered. |
Reimplemented in BESDapErrorInfo, BESSilentInfo, BESVersionInfo, and BESXMLInfo.
Definition at line 283 of file BESInfo.cc.
References BESInfo::_buffered, and BESInfo::_strm.
Referenced by BESInterface::finish(), BESVersionInfo::print(), BESBasicTransmitter::send_html(), BESBasicTransmitter::send_text(), and BESInterface::transmit_data().
void BESHTMLInfo::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the text information as text
use the send_html method on the transmitter to transmit the html formatted 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 265 of file BESHTMLInfo.cc.
References BESTransmitter::send_html().
bool BESInfo::_buffered [protected, inherited] |
Definition at line 73 of file BESInfo.h.
Referenced by BESTextInfo::add_data(), add_data(), BESInfo::BESInfo(), BESInfo::dump(), BESInfo::is_buffered(), and BESInfo::print().
string BESInfo::_response_name [protected, inherited] |
Definition at line 77 of file BESInfo.h.
Referenced by BESXMLInfo::add_tag(), BESXMLInfo::begin_response(), BESInfo::begin_response(), BESXMLInfo::begin_tag(), BESInfo::dump(), BESXMLInfo::end_response(), and BESXMLInfo::end_tag().
bool BESInfo::_response_started [protected, inherited] |
Definition at line 74 of file BESInfo.h.
Referenced by BESInfo::begin_response(), BESInfo::dump(), and BESInfo::end_response().
ostream* BESInfo::_strm [protected, inherited] |
Definition at line 71 of file BESInfo.h.
Referenced by BESTextInfo::add_data(), add_data(), BESInfo::BESInfo(), BESXMLInfo::end_tag(), BESInfo::print(), and BESInfo::~BESInfo().
bool BESInfo::_strm_owned [protected, inherited] |
Definition at line 72 of file BESInfo.h.
Referenced by BESInfo::BESInfo(), and BESInfo::~BESInfo().
stack<string> BESInfo::_tags [protected, inherited] |
Definition at line 76 of file BESInfo.h.
Referenced by BESInfo::begin_tag(), BESInfo::dump(), BESInfo::end_response(), and BESInfo::end_tag().