bes  Updated for version 3.20.6
BESVersionResponseHandler.cc
1 // BESVersionResponseHandler.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 
35 #include <vector>
36 #include <string>
37 
38 using std::vector;
39 using std::string;
40 using std::ostream;
41 
42 #include "BESVersionResponseHandler.h"
43 #include "BESVersionInfo.h"
44 #include "BESRequestHandlerList.h"
45 #include "BESResponseNames.h"
46 #include "ServerAdministrator.h"
47 #include "TheBESKeys.h"
48 
49 #define DEFAULT_ADMINISTRATOR "support@opendap.org"
50 
51 BESVersionResponseHandler::BESVersionResponseHandler(const string &name) :
52  BESResponseHandler(name)
53 {
54 }
55 
56 BESVersionResponseHandler::~BESVersionResponseHandler()
57 {
58 }
59 
75 {
76  BESVersionInfo *info = new BESVersionInfo();
77  d_response_object = info;
78  dhi.action_name = VERS_RESPONSE_STR;
79  info->begin_response( VERS_RESPONSE_STR, dhi);
80 
81  string admin_email = "";
82  try {
84  admin_email = sd.get_email();
85  }
86  catch (...) {
87  admin_email = DEFAULT_ADMINISTRATOR;
88  }
89  if (admin_email.empty()) {
90  admin_email = DEFAULT_ADMINISTRATOR;
91  }
92  info->add_tag("Administrator", admin_email);
93 
94  info->add_library( PACKAGE_NAME, PACKAGE_VERSION);
95 
96  BESRequestHandlerList::TheList()->execute_all(dhi);
97 
98  info->end_response();
99 }
100 
114 {
115  if (d_response_object) {
116  BESVersionInfo *info = dynamic_cast<BESVersionInfo *>(d_response_object);
117  if (!info) throw BESInternalError("cast error", __FILE__, __LINE__);
118  info->transmit(transmitter, dhi);
119  }
120 }
121 
128 void BESVersionResponseHandler::dump(ostream &strm) const
129 {
130  strm << BESIndent::LMarg << "BESVersionResponseHandler::dump - (" << (void *) this << ")" << std::endl;
131  BESIndent::Indent();
133  BESIndent::UnIndent();
134 }
135 
137 BESVersionResponseHandler::VersionResponseBuilder(const string &name)
138 {
139  return new BESVersionResponseHandler(name);
140 }
141 
BESVersionInfo::begin_response
virtual void begin_response(const std::string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESVersionInfo.h:61
BESVersionInfo::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the informational object
Definition: BESVersionInfo.h:103
BESRequestHandlerList::execute_all
virtual void execute_all(BESDataHandlerInterface &dhi)
for all of the registered request handlers, execute the given request
Definition: BESRequestHandlerList.cc:194
BESVersionResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESVersionResponseHandler.cc:128
BESResponseHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESResponseHandler.cc:102
BESVersionResponseHandler::execute
virtual void execute(BESDataHandlerInterface &dhi)
executes the command 'show version;' by returning the version of the BES and the version of all regis...
Definition: BESVersionResponseHandler.cc:74
BESVersionInfo
Definition: BESVersionInfo.h:47
BESVersionResponseHandler
response handler that returns the version of the BES and the version of any data request handlers reg...
Definition: BESVersionResponseHandler.h:50
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
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESVersionResponseHandler::transmit
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the response object built by the execute command using the specified transmitter object
Definition: BESVersionResponseHandler.cc:113
bes::ServerAdministrator
A ServerAdministrator object from the TheBESKeys associated with the string SERVER_ADMIN_KEY.
Definition: ServerAdministrator.h:41