bes  Updated for version 3.20.6
BESHelpResponseHandler.cc
1 // BESHelpResponseHandler.cc
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #include "config.h"
34 #include "BESHelpResponseHandler.h"
35 #include "BESInfoList.h"
36 #include "BESInfo.h"
37 #include "BESRequestHandlerList.h"
38 #include "BESRequestHandler.h"
39 #include "BESResponseNames.h"
40 
41 using std::endl;
42 using std::ostream;
43 using std::string;
44 using std::map;
45 
46 BESHelpResponseHandler::BESHelpResponseHandler( const string &name )
47  : BESResponseHandler( name )
48 {
49 }
50 
51 BESHelpResponseHandler::~BESHelpResponseHandler( )
52 {
53 }
54 
74 void
76 {
77  BESInfo *info = BESInfoList::TheList()->build_info() ;
78  d_response_object = info ;
79 
80  info->begin_response( HELP_RESPONSE_STR, dhi ) ;
81  dhi.action_name = HELP_RESPONSE_STR ;
82 
83  map<string,string> attrs ;
84  attrs["name"] = PACKAGE_NAME ;
85  attrs["version"] = PACKAGE_VERSION ;
86  info->begin_tag( "module", &attrs ) ;
87  info->add_data_from_file( "BES.Help", "BES Help" ) ;
88  info->end_tag( "module" ) ;
89 
90  // execute help for each registered request server
91  info->add_break( 2 ) ;
92 
93  BESRequestHandlerList::TheList()->execute_all( dhi ) ;
94 
95  info->end_response() ;
96 }
97 
110 void
113 {
114  if( d_response_object )
115  {
116  BESInfo *info = dynamic_cast<BESInfo *>(d_response_object) ;
117  if( !info )
118  throw BESInternalError( "cast error", __FILE__, __LINE__ ) ;
119  info->transmit( transmitter, dhi ) ;
120  }
121 }
122 
129 void
130 BESHelpResponseHandler::dump( ostream &strm ) const
131 {
132  strm << BESIndent::LMarg << "BESHelpResponseHandler::dump - ("
133  << (void *)this << ")" << endl ;
134  BESIndent::Indent() ;
135  BESResponseHandler::dump( strm ) ;
136  BESIndent::UnIndent() ;
137 }
138 
140 BESHelpResponseHandler::HelpResponseBuilder( const string &name )
141 {
142  return new BESHelpResponseHandler( name ) ;
143 }
144 
BESHelpResponseHandler::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object
Definition: BESHelpResponseHandler.cc:111
BESRequestHandlerList::execute_all
virtual void execute_all(BESDataHandlerInterface &dhi)
for all of the registered request handlers, execute the given request
Definition: BESRequestHandlerList.cc:194
BESHelpResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESHelpResponseHandler.cc:130
BESResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESResponseHandler.cc:102
BESInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
BESInfo
informational response object
Definition: BESInfo.h:63
BESInfo::add_data_from_file
virtual void add_data_from_file(const std::string &key, const std::string &name)
add data from a file to the informational object.
Definition: BESInfo.cc:182
BESHelpResponseHandler::execute
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show help;' by returning general help information as well as help information f...
Definition: BESHelpResponseHandler.cc:75
BESInternalError
exception thrown if internal error encountered
Definition: BESInternalError.h:43
BESResponseHandler
handler object that knows how to create a specific response object
Definition: BESResponseHandler.h:77
BESTransmitter
Definition: BESTransmitter.h:47
BESInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:124
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESHelpResponseHandler
response handler that returns help information about the server and currently loaded modules.
Definition: BESHelpResponseHandler.h:52