bes  Updated for version 3.17.4
BESDapModule.cc
1 // BESDapModule.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>
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 
32 #include <iostream>
33 
34 using std::endl;
35 
36 #include "BESDapModule.h"
37 
38 #include "BESDapRequestHandler.h"
39 #include "BESRequestHandlerList.h"
40 
41 #include "BESDapNames.h"
42 #include "BESNames.h"
43 #include "BESResponseHandlerList.h"
44 
45 #include "BESDASResponseHandler.h"
46 #include "BESDDSResponseHandler.h"
47 #include "BESDataResponseHandler.h"
48 #include "BESDDXResponseHandler.h"
49 #include "BESDataDDXResponseHandler.h"
50 #include "BESDMRResponseHandler.h"
51 #include "BESDap4ResponseHandler.h"
52 
53 #include "BESCatalogResponseHandler.h"
54 
55 #include "BESServiceRegistry.h"
56 
57 // These I added to test the Null AggregationServer code jhrg 1/30/15
58 #include "BESDapNullAggregationServer.h"
59 // Removed jhrg 3/17/15 #include "BESDapSequenceAggregationServer.h"
60 #include "BESAggFactory.h"
61 
62 #include "BESDapTransmit.h"
63 #include "BESTransmitter.h"
64 #include "BESReturnManager.h"
65 #include "BESTransmitterNames.h"
66 
67 #include "BESDebug.h"
68 #include "BESInternalFatalError.h"
69 #include "BESExceptionManager.h"
70 #include "BESDapError.h"
71 
72 #include "DapFunctionUtils.h"
73 #include "ServerFunctionsList.h"
74 
75 
76 void BESDapModule::initialize(const string &modname)
77 {
78  BESDEBUG("dap", "Initializing DAP Modules:" << endl);
79 
80  BESDEBUG("dap", " adding " << modname << " request handler" << endl);
81  BESRequestHandlerList::TheList()->add_handler(modname, new BESDapRequestHandler(modname));
82 
83  BESDEBUG("dap", " adding " << DAS_RESPONSE << " response handler" << endl);
84  BESResponseHandlerList::TheList()->add_handler(DAS_RESPONSE, BESDASResponseHandler::DASResponseBuilder);
85 
86  BESDEBUG( "dap", " adding " << DDS_RESPONSE << " response handler" << endl );
87  BESResponseHandlerList::TheList()->add_handler( DDS_RESPONSE, BESDDSResponseHandler::DDSResponseBuilder );
88 
89  BESDEBUG("dap", " adding " << DDX_RESPONSE << " response handler" << endl);
90  BESResponseHandlerList::TheList()->add_handler(DDX_RESPONSE, BESDDXResponseHandler::DDXResponseBuilder);
91 
92  BESDEBUG("dap", " adding " << DATA_RESPONSE << " response handler" << endl);
93  BESResponseHandlerList::TheList()->add_handler(DATA_RESPONSE, BESDataResponseHandler::DataResponseBuilder);
94 
95  BESDEBUG("dap", " adding " << DATADDX_RESPONSE << " response handler" << endl);
96  BESResponseHandlerList::TheList()->add_handler(DATADDX_RESPONSE, BESDataDDXResponseHandler::DataDDXResponseBuilder);
97 
98  BESDEBUG("dap", " adding " << DMR_RESPONSE << " response handler" << endl);
99  BESResponseHandlerList::TheList()->add_handler(DMR_RESPONSE, BESDMRResponseHandler::DMRResponseBuilder);
100 
101  BESDEBUG("dap", " adding " << DAP4DATA_RESPONSE << " response handler" << endl);
102  BESResponseHandlerList::TheList()->add_handler(DAP4DATA_RESPONSE, BESDap4ResponseHandler::Dap4ResponseBuilder);
103 
104  BESDEBUG("dap", " adding " << CATALOG_RESPONSE << " response handler" << endl);
105  BESResponseHandlerList::TheList()->add_handler(CATALOG_RESPONSE, BESCatalogResponseHandler::CatalogResponseBuilder);
106 
107  BESDEBUG("dap", "Adding " << OPENDAP_SERVICE << " services:" << endl);
108  BESServiceRegistry *registry = BESServiceRegistry::TheRegistry();
109  registry->add_service(OPENDAP_SERVICE);
110  registry->add_to_service(OPENDAP_SERVICE, DAS_SERVICE, DAS_DESCRIPT, DAP2_FORMAT);
111  registry->add_to_service(OPENDAP_SERVICE, DDS_SERVICE, DDS_DESCRIPT, DAP2_FORMAT);
112  registry->add_to_service(OPENDAP_SERVICE, DDX_SERVICE, DDX_DESCRIPT, DAP2_FORMAT);
113  registry->add_to_service(OPENDAP_SERVICE, DATA_SERVICE, DATA_DESCRIPT, DAP2_FORMAT);
114  registry->add_to_service(OPENDAP_SERVICE, DATADDX_SERVICE, DATADDX_DESCRIPT, DAP2_FORMAT);
115 
116  registry->add_to_service(OPENDAP_SERVICE, DMR_SERVICE, DMR_DESCRIPT, DAP2_FORMAT);
117  registry->add_to_service(OPENDAP_SERVICE, DAP4DATA_SERVICE, DAP4DATA_DESCRIPT, DAP2_FORMAT);
118 
119  BESDEBUG("dap", "Initializing DAP Basic Transmitters:" << endl);
120  BESReturnManager::TheManager()->add_transmitter(DAP2_FORMAT, new BESDapTransmit());
121  // TODO ?? BESReturnManager::TheManager()->add_transmitter( DAP4_FORMAT, new BESDapTransmit( ) );
122 
123  BESDEBUG("dap", " adding dap exception handler" << endl);
124  BESExceptionManager::TheEHM()->add_ehm_callback(BESDapError::handleException);
125 
126  // Add the new 'Null' AggregationServer. jhrg 1/30/15
127  // TODO Add these names to BESDapNames.h
128  BESDEBUG("dap", " adding null aggregation handler" << endl);
129  BESAggFactory::TheFactory()->add_handler("null.aggregation", BESDapNullAggregationServer::NewBESDapNullAggregationServer);
130 #if 0
131  // Removed jhrg 3/17/15
132  BESAggFactory::TheFactory()->add_handler("sequence.aggregation", BESDapSequenceAggregationServer::NewBESDapSequenceAggregationServer);
133 #endif
134 
135 
136  BESDEBUG("dap", " adding DAP Utility Function 'wrapitup'()" << endl);
137  WrapItUp *wiu = new WrapItUp();
138  libdap::ServerFunctionsList::TheList()->add_function(wiu);
139 
140 
141  BESDEBUG("dap", " adding dap debug context" << endl);
142  BESDebug::Register("dap");
143 
144 
145 
146 
147 
148  BESDEBUG("dap", "Done Initializing DAP Modules:" << endl);
149 }
150 
151 void BESDapModule::terminate(const string &modname)
152 {
153  BESDEBUG("dap", "Removing DAP Modules:" << endl);
154 
155  BESResponseHandlerList::TheList()->remove_handler(DAS_RESPONSE);
156  BESResponseHandlerList::TheList()->remove_handler(DDS_RESPONSE);
157  BESResponseHandlerList::TheList()->remove_handler(DDX_RESPONSE);
158  BESResponseHandlerList::TheList()->remove_handler(DATA_RESPONSE);
159  BESResponseHandlerList::TheList()->remove_handler(DATADDX_RESPONSE);
160  BESResponseHandlerList::TheList()->remove_handler(CATALOG_RESPONSE);
161 
162  BESResponseHandlerList::TheList()->remove_handler(DMR_RESPONSE);
163  BESResponseHandlerList::TheList()->remove_handler(DAP4DATA_RESPONSE);
164 
165  BESResponseHandlerList::TheList()->remove_handler(CATALOG_RESPONSE);
166 
167  BESDEBUG("dap", " removing " << OPENDAP_SERVICE << " services" << endl);
168  BESServiceRegistry::TheRegistry()->remove_service(OPENDAP_SERVICE);
169 
170  BESDEBUG("dap", " removing dap Request Handler " << modname << endl);
171  BESRequestHandler *rh = BESRequestHandlerList::TheList()->remove_handler(modname);
172  if (rh) delete rh;
173 
174  BESReturnManager::TheManager()->del_transmitter(DAP2_FORMAT);
175  // TODO ?? BESReturnManager::TheManager()->del_transmitter( DAP4_FORMAT );
176 
177  BESAggFactory::TheFactory()->remove_handler("null.aggregation");
178 
179  BESDEBUG("dap", "Done Removing DAP Modules:" << endl);
180 }
181 
188 void BESDapModule::dump(ostream &strm) const
189 {
190  strm << BESIndent::LMarg << "BESDapModule::dump - (" << (void *) this << ")" << endl;
191 }
192 
193 extern "C" {
194 BESAbstractModule *maker()
195 {
196  return new BESDapModule;
197 }
198 }
199 
static BESAggregationServer * NewBESDapNullAggregationServer(const string &name)
virtual bool add_handler(const string &handler_name, BESRequestHandler *handler)
add a request handler to the list of registered handlers for this server
virtual void add_service(const string &name)
Add a service to the BES.
The service registry allows modules to register services with the BES that they provide.
virtual void add_to_service(const string &service, const string &cmd, const string &cmd_descript, const string &format)
This function allows callers to add to a service that already exists.
virtual void add_ehm_callback(p_bes_ehm ehm)
Register an exception handler with the manager.
virtual void remove_service(const string &name)
remove a service from the BES
virtual bool remove_handler(const string &handler_name)
removes a response handler from the list
virtual void dump(ostream &strm) const
dumps information about this object
virtual bool add_handler(const string &handler, p_response_handler handler_method)
add a response handler to the list
Represents a specific data type request handler.
virtual bool remove_handler(const string &handler)
removes a response handler from the list
static int handleException(BESError &e, BESDataHandlerInterface &dhi)
handles exceptions if the error context is set to dap2
Definition: BESDapError.cc:109
virtual bool add_handler(const string &handler_name, p_agg_handler handler_method)
add an aggregation handler to the list
static void Register(const string &flagName)
register the specified debug flag
Definition: BESDebug.h:145
virtual BESRequestHandler * remove_handler(const string &handler_name)
remove and return the specified request handler