OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESTextInfo Class Reference

brief represents simple text information in a response object, such as version and help inforamtion. More...

#include <BESTextInfo.h>

Inheritance diagram for BESTextInfo:
Inheritance graph
Collaboration diagram for BESTextInfo:
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 string &s)
 add string data to the informational response 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...
 
 BESTextInfo (bool ishttp=false)
 constructs a basic text information response object. More...
 
 BESTextInfo (const string &key, ostream *strm, bool strm_owned, bool ishttp=false)
 constructs a basic text information response object. More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void end_response ()
 
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...
 
virtual ~BESTextInfo ()
 

Static Public Member Functions

static BESInfoBuildTextInfo (const string &info_type)
 

Protected Attributes

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

Detailed Description

brief represents simple text information in a response object, such as version and help inforamtion.

Uses the default add_data and print methods, where the print method, if the response is going to a browser, sets the mime type to text.

See also
BESInfo
BESResponseObject

Definition at line 47 of file BESTextInfo.h.

Constructor & Destructor Documentation

◆ BESTextInfo() [1/2]

BESTextInfo::BESTextInfo ( bool  ishttp = false)

constructs a basic text information response object.

Text informational objects can also be sent as html with an html header. We need to know this if the informationl is not buffered. If it isn't buffered then we need to send that text header.

See also
BESInfo
BESResponseObject

Definition at line 54 of file BESTextInfo.cc.

Referenced by BuildTextInfo().

◆ BESTextInfo() [2/2]

BESTextInfo::BESTextInfo ( const string &  key,
ostream *  strm,
bool  strm_owned,
bool  ishttp = false 
)

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.

Text informational objects can also be sent as html with an html header. We need to know this if the informationl is not buffered. If it isn't buffered then we need to send that text header.

Parameters
keyparameter from BES configuration file
strmif not buffered then use the passed stream
strm_ownedif strm created (not cout or cerr for example) then tells whether strm owned or not and can be deleted
ishttptells whether this text information is html text and therefor requires the html header
See also
BESInfo
BESResponseObject

Definition at line 80 of file BESTextInfo.cc.

◆ ~BESTextInfo()

BESTextInfo::~BESTextInfo ( )
virtual

Definition at line 88 of file BESTextInfo.cc.

Member Function Documentation

◆ add_break()

void BESTextInfo::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 205 of file BESTextInfo.cc.

References add_data().

Here is the call graph for this function:

◆ add_data()

void BESTextInfo::add_data ( const string &  s)
virtual

add string data to the informational response

Parameters
sstring data to add the informational response

Reimplemented from BESInfo.

Definition at line 175 of file BESTextInfo.cc.

References BESInfo::_buffered, BESInfo::_strm, BESInfo::add_data(), and BESUtil::set_mime_text().

Referenced by add_break(), add_space(), add_tag(), and begin_tag().

Here is the call graph for this function:

◆ add_data_from_file()

void BESTextInfo::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 .TXT 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 224 of file BESTextInfo.cc.

References BESInfo::add_data_from_file().

Here is the call graph for this function:

◆ add_exception()

void BESInfo::add_exception ( BESError e,
const 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, BESDapErrorInfo, and BESSilentInfo.

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().

Here is the call graph for this function:

◆ add_space()

void BESTextInfo::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 190 of file BESTextInfo.cc.

References add_data().

Here is the call graph for this function:

◆ add_tag()

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

add tagged information to the inforamtional 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 113 of file BESTextInfo.cc.

References add_data().

Here is the call graph for this function:

◆ begin_response()

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

begin the informational response

Because this is text informational object, no begin tags are needed

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

Reimplemented from BESInfo.

Definition at line 100 of file BESTextInfo.cc.

References BESInfo::begin_response().

Here is the call graph for this function:

◆ begin_tag()

void BESTextInfo::begin_tag ( const string &  tag_name,
map< string, 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 137 of file BESTextInfo.cc.

References add_data(), and BESInfo::begin_tag().

Here is the call graph for this function:

◆ BuildTextInfo()

BESInfo * BESTextInfo::BuildTextInfo ( const string &  info_type)
static

Definition at line 266 of file BESTextInfo.cc.

References BESTextInfo().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

◆ dump()

void BESTextInfo::dump ( ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance along with information about this text information object

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

Reimplemented from BESInfo.

Definition at line 253 of file BESTextInfo.cc.

References BESInfo::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

◆ end_response()

◆ end_tag()

void BESTextInfo::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.

Parameters
tag_namename of the tag to end

Reimplemented from BESInfo.

Definition at line 163 of file BESTextInfo.cc.

References BESInfo::end_tag().

Here is the call graph for this function:

◆ 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 123 of file BESInfo.h.

References BESInfo::_buffered, and BESInfo::dump().

Referenced by BESBasicHttpTransmitter::send_html(), BESBasicTransmitter::send_html(), BESBasicTransmitter::send_text(), and BESBasicHttpTransmitter::send_text().

Here is the call graph for this function:

◆ print()

void BESInfo::print ( ostream &  strm)
virtualinherited

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.

Parameters
strmoutput to this file descriptor if information buffered.

Reimplemented in BESVersionInfo, BESXMLInfo, BESDapErrorInfo, and BESSilentInfo.

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().

◆ transmit()

void BESTextInfo::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 239 of file BESTextInfo.cc.

References BESTransmitter::send_text().

Here is the call graph for this function:

Member Data Documentation

◆ _buffered

bool BESInfo::_buffered
protectedinherited

◆ _response_name

◆ _response_started

bool BESInfo::_response_started
protectedinherited

Definition at line 74 of file BESInfo.h.

Referenced by BESInfo::begin_response(), BESInfo::dump(), and BESInfo::end_response().

◆ _strm

ostream* BESInfo::_strm
protectedinherited

◆ _strm_owned

bool BESInfo::_strm_owned
protectedinherited

Definition at line 72 of file BESInfo.h.

Referenced by BESInfo::BESInfo(), and BESInfo::~BESInfo().

◆ _tags

stack<string> BESInfo::_tags
protectedinherited

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