00001 // BESHelpResponseHandler.cc 00002 00003 // This file is part of bes, A C++ back-end server implementation framework 00004 // for the OPeNDAP Data Access Protocol. 00005 00006 // Copyright (c) 2004,2005 University Corporation for Atmospheric Research 00007 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu> 00008 // 00009 // This library is free software; you can redistribute it and/or 00010 // modify it under the terms of the GNU Lesser General Public 00011 // License as published by the Free Software Foundation; either 00012 // version 2.1 of the License, or (at your option) any later version. 00013 // 00014 // This library is distributed in the hope that it will be useful, 00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00017 // Lesser General Public License for more details. 00018 // 00019 // You should have received a copy of the GNU Lesser General Public 00020 // License along with this library; if not, write to the Free Software 00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 00022 // 00023 // You can contact University Corporation for Atmospheric Research at 00024 // 3080 Center Green Drive, Boulder, CO 80301 00025 00026 // (c) COPYRIGHT University Corporation for Atmostpheric Research 2004-2005 00027 // Please read the full copyright statement in the file COPYRIGHT_UCAR. 00028 // 00029 // Authors: 00030 // pwest Patrick West <pwest@ucar.edu> 00031 // jgarcia Jose Garcia <jgarcia@ucar.edu> 00032 00033 #include "BESHelpResponseHandler.h" 00034 #include "BESInfoList.h" 00035 #include "BESInfo.h" 00036 #include "BESRequestHandlerList.h" 00037 #include "BESRequestHandler.h" 00038 #include "BESResponseNames.h" 00039 00040 BESHelpResponseHandler::BESHelpResponseHandler( string name ) 00041 : BESResponseHandler( name ) 00042 { 00043 } 00044 00045 BESHelpResponseHandler::~BESHelpResponseHandler( ) 00046 { 00047 } 00048 00072 void 00073 BESHelpResponseHandler::execute( BESDataHandlerInterface &dhi ) 00074 { 00075 BESInfo *info = BESInfoList::TheList()->build_info() ; 00076 _response = info ; 00077 00078 info->begin_response( HELP_RESPONSE_STR ) ; 00079 dhi.action_name = HELP_RESPONSE_STR ; 00080 00081 info->begin_tag( "BES" ) ; 00082 info->add_data_from_file( "BES.Help", "BES Help" ) ; 00083 info->end_tag( "BES" ) ; 00084 00085 // execute help for each registered request server 00086 info->add_break( 2 ) ; 00087 00088 info->begin_tag( "Handlers" ) ; 00089 BESRequestHandlerList::TheList()->execute_all( dhi ) ; 00090 info->end_tag( "Handlers" ) ; 00091 00092 info->end_response() ; 00093 } 00094 00107 void 00108 BESHelpResponseHandler::transmit( BESTransmitter *transmitter, 00109 BESDataHandlerInterface &dhi ) 00110 { 00111 if( _response ) 00112 { 00113 BESInfo *info = dynamic_cast<BESInfo *>(_response) ; 00114 info->transmit( transmitter, dhi ) ; 00115 } 00116 } 00117 00124 void 00125 BESHelpResponseHandler::dump( ostream &strm ) const 00126 { 00127 strm << BESIndent::LMarg << "BESHelpResponseHandler::dump - (" 00128 << (void *)this << ")" << endl ; 00129 BESIndent::Indent() ; 00130 BESResponseHandler::dump( strm ) ; 00131 BESIndent::UnIndent() ; 00132 } 00133 00134 BESResponseHandler * 00135 BESHelpResponseHandler::HelpResponseBuilder( string handler_name ) 00136 { 00137 return new BESHelpResponseHandler( handler_name ) ; 00138 } 00139