response handler that returns help information about the server and currently loaded modules. More...
#include <BESHelpResponseHandler.h>
Public Member Functions | |
BESHelpResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
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 string | get_name () const |
return the name of this response object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESHelpResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | HelpResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
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.
Definition at line 52 of file BESHelpResponseHandler.h.
BESHelpResponseHandler::BESHelpResponseHandler | ( | const string & | name | ) |
Definition at line 41 of file BESHelpResponseHandler.cc.
Referenced by HelpResponseBuilder().
BESHelpResponseHandler::~BESHelpResponseHandler | ( | void | ) | [virtual] |
Definition at line 46 of file BESHelpResponseHandler.cc.
void BESHelpResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 125 of file BESHelpResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
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.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 70 of file BESHelpResponseHandler.cc.
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, PACKAGE_NAME, PACKAGE_VERSION, BESRequestHandlerList::TheList(), and BESInfoList::TheList().
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...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().
BESResponseHandler * BESHelpResponseHandler::HelpResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 135 of file BESHelpResponseHandler.cc.
References BESHelpResponseHandler().
Referenced by BESDefaultModule::initialize().
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.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 106 of file BESHelpResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::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(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().