OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESHelpResponseHandler.cc
Go to the documentation of this file.
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 
42  : BESResponseHandler( name )
43 {
44 }
45 
47 {
48 }
49 
69 void
71 {
73  _response = info ;
74 
75  info->begin_response( HELP_RESPONSE_STR, dhi ) ;
77 
78  map<string,string> attrs ;
79  attrs["name"] = PACKAGE_NAME ;
80  attrs["version"] = PACKAGE_VERSION ;
81  info->begin_tag( "module", &attrs ) ;
82  info->add_data_from_file( "BES.Help", "BES Help" ) ;
83  info->end_tag( "module" ) ;
84 
85  // execute help for each registered request server
86  info->add_break( 2 ) ;
87 
89 
90  info->end_response() ;
91 }
92 
105 void
108 {
109  if( _response )
110  {
111  BESInfo *info = dynamic_cast<BESInfo *>(_response) ;
112  if( !info )
113  throw BESInternalError( "cast error", __FILE__, __LINE__ ) ;
114  info->transmit( transmitter, dhi ) ;
115  }
116 }
117 
124 void
125 BESHelpResponseHandler::dump( ostream &strm ) const
126 {
127  strm << BESIndent::LMarg << "BESHelpResponseHandler::dump - ("
128  << (void *)this << ")" << endl ;
130  BESResponseHandler::dump( strm ) ;
132 }
133 
136 {
137  return new BESHelpResponseHandler( name ) ;
138 }
139 
virtual BESInfo * build_info()
Definition: BESInfoList.cc:77
virtual void end_response()
Definition: BESInfo.cc:131
exception thrown if inernal error encountered
virtual void add_data_from_file(const string &key, const string &name)
add data from a file to the informational object.
Definition: BESInfo.cc:192
virtual void dump(ostream &strm) const
dumps information about this object
static BESInfoList * TheList()
Definition: BESInfoList.cc:142
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)=0
transmit the informational object
static void Indent()
Definition: BESIndent.cc:38
BESResponseObject * _response
handler object that knows how to create a specific response object
informational response object
Definition: BESInfo.h:68
#define PACKAGE_NAME
Definition: config.h:135
#define HELP_RESPONSE_STR
virtual void begin_tag(const string &tag_name, map< string, string > *attrs=0)
Definition: BESInfo.cc:142
static ostream & LMarg(ostream &strm)
Definition: BESIndent.cc:73
virtual void execute_all(BESDataHandlerInterface &dhi)
for all of the registered request handlers, execute the given request
virtual void add_break(unsigned long num_breaks)=0
virtual void dump(ostream &strm) const
dumps information about this object
BESHelpResponseHandler(const string &name)
static BESRequestHandlerList * TheList()
Structure storing information used by the BES to handle the request.
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object ...
virtual void begin_response(const string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESInfo.cc:123
#define PACKAGE_VERSION
Definition: config.h:147
static BESResponseHandler * HelpResponseBuilder(const string &name)
static void UnIndent()
Definition: BESIndent.cc:44
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show help;' by returning general help information as well as help information f...
virtual void end_tag(const string &tag_name)
Definition: BESInfo.cc:149