bes  Updated for version 3.20.6
BESXMLDapCommandModule.cc
1 // BESXMLDapCommandModule.cc
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the DAP 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 <iostream>
34 
35 #include "BESResponseHandlerList.h"
36 #include "BESXMLDapCommandModule.h"
37 #include "BESDapNames.h"
38 #include "BESNames.h"
39 #include "BESDebug.h"
40 #include "BESXMLCatalogCommand.h"
41 // #include "SiteMapCommandNames.h"
42 #include "SiteMapCommand.h" // Uses NullResponseHandler
43 #include "SiteMapResponseHandler.h"
44 #include "ShowNodeCommand.h" // Could use NullResponseHandler. jhrg 7/23/18
45 
46 using namespace bes;
47 using std::endl;
48 using std::cout;
49 using std::ostream;
50 using std::string;
51 
61 void BESXMLDapCommandModule::initialize(const string &/*modname*/)
62 {
63  BESDEBUG("dap", "Initializing DAP Commands:" << endl);
64 
65  BESXMLCommand::add_command(CATALOG_RESPONSE_STR, BESXMLCatalogCommand::CommandBuilder);
67 
68  // Build a site map. Originally used the Null Response Handler, now
69  // it returns a response to the caller. jhrg 11/26/18
71  BESResponseHandlerList::TheList()->add_handler(SITE_MAP_RESPONSE, SiteMapResponseHandler::SiteMapResponseBuilder);
72 
73  BESDEBUG("dap", "Done Initializing DAP Commands:" << endl);
74 }
75 
84 void BESXMLDapCommandModule::terminate(const string &/*modname*/)
85 {
86  BESDEBUG("dap", "Removing DAP Commands" << endl);
87 
88  BESXMLCommand::del_command(CATALOG_RESPONSE_STR);
89  BESXMLCommand::del_command(SITE_MAP_RESPONSE_STR);
90 
91  BESResponseHandlerList::TheList()->remove_handler(SITE_MAP_RESPONSE);
92 
93  BESDEBUG("dap", "Done Removing DAP Commands" << endl);
94 }
95 
102 void BESXMLDapCommandModule::dump(ostream &strm) const
103 {
104  strm << BESIndent::LMarg << "BESXMLDapCommandModule::dump - (" << (void *) this << ")" << endl;
105 }
106 
107 extern "C" {
108 
109 BESAbstractModule *maker()
110 {
111  return new BESXMLDapCommandModule;
112 }
113 
114 }
115 
BESXMLDapCommandModule::terminate
virtual void terminate(const std::string &modname)
Cleans up the DAP XML commands from the list of possible commands.
Definition: BESXMLDapCommandModule.cc:84
BESAbstractModule
Definition: BESAbstractModule.h:40
SiteMapCommand::CommandBuilder
static BESXMLCommand * CommandBuilder(const BESDataHandlerInterface &base_dhi)
Factory for the SiteMapCommand.
Definition: SiteMapCommand.cc:120
bes::ShowNodeCommand::CommandBuilder
static BESXMLCommand * CommandBuilder(const BESDataHandlerInterface &base_dhi)
A command builder suitable for BESXMLCommand::add_command()
Definition: ShowNodeCommand.cc:130
BESXMLCommand::add_command
static void add_command(const std::string &cmd_str, p_xmlcmd_builder cmd)
Add a command to the possible commands allowed by this BES.
Definition: BESXMLCommand.cc:86
BESResponseHandlerList::remove_handler
virtual bool remove_handler(const std::string &handler)
removes a response handler from the list
Definition: BESResponseHandlerList.cc:74
BESXMLDapCommandModule::initialize
virtual void initialize(const std::string &modname)
Adds the basic DAP XML command objects to the XMLCommand list of possible commands.
Definition: BESXMLDapCommandModule.cc:61
BESXMLDapCommandModule
Definition: BESXMLDapCommandModule.h:38
BESXMLCommand::del_command
static void del_command(const std::string &cmd_str)
Deletes the command called cmd_str from the list of possible commands.
Definition: BESXMLCommand.cc:96
BESResponseHandlerList::add_handler
virtual bool add_handler(const std::string &handler, p_response_handler handler_method)
add a response handler to the list
Definition: BESResponseHandlerList.cc:55
BESXMLDapCommandModule::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESXMLDapCommandModule.cc:102