BESHelpResponseHandler Class Reference

response handler that returns help information about the server and currently loaded modules. More...

#include <BESHelpResponseHandler.h>

Inheritance diagram for BESHelpResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESHelpResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESHelpResponseHandler (const string &name)
virtual ~BESHelpResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show help;' by returning general help information as well as help information for all of the data request handlers registered.
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object
virtual void dump (ostream &strm) const
 dumps information about this object
virtual BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
virtual string get_name () const
 return the name of this response object

Static Public Member Functions

static BESResponseHandlerHelpResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that returns help information about the server and currently loaded modules.

A request 'show help;' will be handled by this response handler. It returns general help information as well as help information for all of the different types of data handled by this server. The list of request handlers (data handlers) registered with the server are listed along with the responses those handlers can handle. Each of those request handlers are given the chance to provide further help.

See also:
BESResponseObject

BESContainer

BESTransmitter


Constructor & Destructor Documentation

BESHelpResponseHandler::BESHelpResponseHandler ( const string &  name  ) 

Referenced by HelpResponseBuilder().

BESHelpResponseHandler::~BESHelpResponseHandler ( void   )  [virtual]


Member Function Documentation

void BESHelpResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

executes the command 'show help;' by returning general help information as well as help information for all of the data request handlers registered.

The BESHelpResponseHandler first retreives general help information from help files located in the file pointed to by either the key BES.Help.TXT if the client is a basic text client or BES.Help.HTTP if the client is HTML based. It then lists each of the data types registered to handle requests (such as NetCDF, HDF, Cedar, etc...). Then for all data request handlers registered with BESRequestHandlerList help information can be added to the informational object.

The response object BESHTMLInfo is created to store the help information.

Parameters:
dhi structure that holds request and response information
See also:
_BESDataHandlerInterface

BESHTMLInfo

BESRequestHandlerList

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::add_break(), BESInfo::add_data_from_file(), BESInfo::begin_response(), BESInfo::begin_tag(), BESInfoList::build_info(), BESInfo::end_response(), BESInfo::end_tag(), BESRequestHandlerList::execute_all(), HELP_RESPONSE_STR, BESRequestHandlerList::TheList(), and BESInfoList::TheList().

Here is the call graph for this function:

void BESHelpResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

transmit the response object built by the execute command using the specified transmitter object

If a response object was built then transmit it as text or html, depending on whether the client making the request can handle HTML information.

Parameters:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
See also:
BESHTMLInfo

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

References BESResponseHandler::_response, and BESInfo::transmit().

Here is the call graph for this function:

void BESHelpResponseHandler::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

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

Here is the call graph for this function:

BESResponseHandler * BESHelpResponseHandler::HelpResponseBuilder ( const string &  name  )  [static]

References BESHelpResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

BESResponseObject * BESResponseHandler::get_response_object (  )  [virtual, inherited]

return the current response object

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns:
current response object
See also:
BESResponseObject

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o  )  [virtual, inherited]

replaces the current response object with the specified one, returning the current response object

This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.

The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.

Parameters:
o new response object used to replace the current one
Returns:
the response object being replaced
See also:
BESResponseObject

References BESResponseHandler::_response.

virtual string BESResponseHandler::get_name (  )  const [inline, virtual, inherited]

return the name of this response object

This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...

Returns:
response name

References BESResponseHandler::_response_name.


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().


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

Generated on Wed Sep 24 12:29:13 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6