bes  Updated for version 3.20.6
BESXMLInfo Class Reference

represents an xml formatted response object More...

#include <BESXMLInfo.h>

Collaboration diagram for BESXMLInfo:
Collaboration graph

Public Member Functions

virtual void add_break (unsigned long num_breaks)
 add a line break to the information More...
 
virtual void add_data (const std::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 std::string &key, const std::string &name)
 add data from a file to the informational object More...
 
virtual void add_exception (BESError &e, const std::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 std::string &tag_name, const std::string &tag_data, std::map< std::string, std::string > *attrs=0)
 add tagged information to the informational response More...
 
virtual void begin_response (const std::string &response_name, BESDataHandlerInterface &dhi)
 begin the informational response More...
 
virtual void begin_response (const std::string &response_name, std::map< std::string, std::string > *attrs, BESDataHandlerInterface &dhi)
 begin the informational response More...
 
virtual void begin_tag (const std::string &tag_name, std::map< std::string, std::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 (std::ostream &strm) const
 dumps information about this object More...
 
virtual void end_response ()
 end the response More...
 
virtual void end_tag (const std::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 (std::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 BESInfoBuildXMLInfo (const std::string &info_type)
 

Protected Member Functions

virtual void begin_tag (const std::string &tag_name, const std::string &ns, const std::string &uri, std::map< std::string, std::string > *attrs=0)
 begin a tagged part of the information, information to follow More...
 

Protected Attributes

bool _buffered
 
std::string _response_name
 
bool _response_started
 
std::ostream * _strm
 
bool _strm_owned
 
std::stack< std::string > _tags
 

Detailed Description

represents an xml formatted response object

An informational response object that is formated as an XML document.

See also
BESInfo
BESResponseObject

Definition at line 48 of file BESXMLInfo.h.

Constructor & Destructor Documentation

◆ BESXMLInfo()

BESXMLInfo::BESXMLInfo ( )

constructs an informational response object as an xml document

See also
BESInfo
BESResponseObject

Definition at line 54 of file BESXMLInfo.cc.

Member Function Documentation

◆ add_break()

void BESXMLInfo::add_break ( unsigned long  num_breaks)
virtual

add a line break to the information

Parameters
num_breaksthe number of line breaks to add to the information

Implements BESInfo.

Definition at line 432 of file BESXMLInfo.cc.

◆ add_data()

void BESXMLInfo::add_data ( const std::string &  s)
virtual

add data to this informational object. If buffering is not set then the information is output directly to the output stream.

Parameters
sinformation to be added to this informational response object

Reimplemented from BESInfo.

Definition at line 441 of file BESXMLInfo.cc.

◆ add_data_from_file()

void BESXMLInfo::add_data_from_file ( const std::string &  key,
const std::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.

Parameters
keyKey from the initialization file specifying the file to be
nameA description of what is the information being loaded

Reimplemented from BESInfo.

Definition at line 462 of file BESXMLInfo.cc.

◆ add_exception()

void BESInfo::add_exception ( BESError e,
const std::string &  admin 
)
virtualinherited

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.

Parameters
eThe exception to add to the informational response object
adminThe contact information for the person responsible for this error

Reimplemented in BESVersionInfo, and BESDapErrorInfo.

Definition at line 234 of file BESInfo.cc.

◆ add_space()

void BESXMLInfo::add_space ( unsigned long  num_spaces)
virtual

add a space to the informational response

Parameters
num_spacesthe number of spaces to add to the information

Implements BESInfo.

Definition at line 419 of file BESXMLInfo.cc.

◆ add_tag()

void BESXMLInfo::add_tag ( const std::string &  tag_name,
const std::string &  tag_data,
std::map< std::string, std::string > *  attrs = 0 
)
virtual

add tagged information to the informational response

Parameters
tag_namename of the tag to be added to the response
tag_datainformation describing the tag
attrsmap of attributes to add to the tag

Implements BESInfo.

Definition at line 269 of file BESXMLInfo.cc.

◆ begin_response() [1/2]

void BESXMLInfo::begin_response ( const std::string &  response_name,
BESDataHandlerInterface dhi 
)
virtual

begin the informational response

This will add the response name as well as the <response> tag to the informational response object

Parameters
response_namename of the response this information represents
dhiinformation about the request and response

Reimplemented from BESInfo.

Definition at line 96 of file BESXMLInfo.cc.

◆ begin_response() [2/2]

void BESXMLInfo::begin_response ( const std::string &  response_name,
std::map< std::string, std::string > *  attrs,
BESDataHandlerInterface dhi 
)
virtual

begin the informational response

This will add the response name as well as the <response> tag to the informational response object

Parameters
response_namename of the response this information represents
dhiinformation about the request and response

Reimplemented from BESInfo.

Definition at line 110 of file BESXMLInfo.cc.

◆ begin_tag() [1/2]

void BESXMLInfo::begin_tag ( const std::string &  tag_name,
const std::string &  ns,
const std::string &  uri,
std::map< std::string, std::string > *  attrs = 0 
)
protectedvirtual

begin a tagged part of the information, information to follow

Parameters
tag_namename of the tag to begin
nsnamespace name to include in the tag
urinamespace uri
attrsmap of attributes to begin the tag with

Definition at line 334 of file BESXMLInfo.cc.

◆ begin_tag() [2/2]

void BESXMLInfo::begin_tag ( const std::string &  tag_name,
std::map< std::string, std::string > *  attrs = 0 
)
virtual

begin a tagged part of the information, information to follow

Parameters
tag_namename of the tag to begin
attrsmap of attributes to begin the tag with

Reimplemented from BESInfo.

Definition at line 322 of file BESXMLInfo.cc.

◆ dump()

void BESXMLInfo::dump ( std::ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance along with information about this XML informational object.

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESInfo.

Definition at line 510 of file BESXMLInfo.cc.

◆ end_response()

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.

Definition at line 215 of file BESXMLInfo.cc.

◆ end_tag()

void BESXMLInfo::end_tag ( const std::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.

Parameters
tag_namename of the tag to end

Reimplemented from BESInfo.

Definition at line 387 of file BESXMLInfo.cc.

◆ is_buffered()

virtual bool BESInfo::is_buffered ( )
inlinevirtualinherited

return whether the information is to be buffered or not.

Returns
true if information is buffered, false if not

Definition at line 111 of file BESInfo.h.

◆ print()

void BESXMLInfo::print ( std::ostream &  strm)
virtual

print the information from this informational object to the specified stream

Parameters
strmoutput to this stream

Reimplemented from BESInfo.

Definition at line 495 of file BESXMLInfo.cc.

◆ transmit()

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.

Parameters
transmitterThe type of transmitter to use to transmit the info
dhiinformation to help with the transmission

Implements BESInfo.

Definition at line 482 of file BESXMLInfo.cc.


The documentation for this class was generated from the following files: