OPeNDAP Hyrax Back End Server (BES) Updated for version 3.8.3
BESHelpResponseHandler.cc
Go to the documentation of this file.
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-2009 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 Atmospheric 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 "config.h"
00034 #include "BESHelpResponseHandler.h"
00035 #include "BESInfoList.h"
00036 #include "BESInfo.h"
00037 #include "BESRequestHandlerList.h"
00038 #include "BESRequestHandler.h"
00039 #include "BESResponseNames.h"
00040 
00041 BESHelpResponseHandler::BESHelpResponseHandler( const string &name )
00042     : BESResponseHandler( name )
00043 {
00044 }
00045 
00046 BESHelpResponseHandler::~BESHelpResponseHandler( )
00047 {
00048 }
00049 
00069 void
00070 BESHelpResponseHandler::execute( BESDataHandlerInterface &dhi )
00071 {
00072     BESInfo *info = BESInfoList::TheList()->build_info() ;
00073     _response = info ;
00074 
00075     info->begin_response( HELP_RESPONSE_STR, dhi ) ;
00076     dhi.action_name = HELP_RESPONSE_STR ;
00077 
00078     map<string,string> attrs ;
00079     attrs["name"] = PACKAGE_NAME ;
00080     attrs["version"] = PACKAGE_VERSION ;
00081     info->begin_tag( "module", &attrs ) ;
00082     info->add_data_from_file( "BES.Help", "BES Help" ) ;
00083     info->end_tag( "module" ) ;
00084 
00085     // execute help for each registered request server
00086     info->add_break( 2 ) ;
00087 
00088     BESRequestHandlerList::TheList()->execute_all( dhi ) ;
00089 
00090     info->end_response() ;
00091 }
00092 
00105 void
00106 BESHelpResponseHandler::transmit( BESTransmitter *transmitter,
00107                                BESDataHandlerInterface &dhi )
00108 {
00109     if( _response )
00110     {
00111         BESInfo *info = dynamic_cast<BESInfo *>(_response) ;
00112         if( !info )
00113             throw BESInternalError( "cast error", __FILE__, __LINE__ ) ;
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( const string &name )
00136 {
00137     return new BESHelpResponseHandler( name ) ;
00138 }
00139