bes  Updated for version 3.20.10
BESRequestHandlerList.h
1  // BESRequestHandlerList.h
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 #ifndef I_BESRequestHandlerList_h
34 #define I_BESRequestHandlerList_h 1
35 
36 #include <map>
37 #include <string>
38 #include <mutex>
39 
40 #include "BESObj.h"
41 
42 #if 0
43 #include "BESDataHandlerInterface.h"
44 #endif
45 
46 #include "BESRequestHandler.h"
47 //class BESRequestHandler;
49 
72 private:
73  static BESRequestHandlerList * d_instance;
74  mutable std::recursive_mutex d_cache_lock_mutex;
75 
76  static void initialize_instance();
77  static void delete_instance();
78 
79  std::map<std::string, BESRequestHandler *> _handler_list;
80 
81 public:
83  virtual ~BESRequestHandlerList();
84 
85  typedef std::map<std::string, BESRequestHandler *>::const_iterator Handler_citer;
86  typedef std::map<std::string, BESRequestHandler *>::iterator Handler_iter;
87 
88  virtual bool add_handler(const std::string &handler_name, BESRequestHandler * handler);
89  virtual BESRequestHandler * remove_handler(const std::string &handler_name);
90  virtual BESRequestHandler * find_handler(const std::string &handler_name);
91 
92  virtual Handler_citer get_first_handler();
93  virtual Handler_citer get_last_handler();
94 
95  virtual std::string get_handler_names();
96 
97  virtual void execute_each(BESDataHandlerInterface &dhi);
98  virtual void execute_all(BESDataHandlerInterface &dhi);
99 #if 0
100  virtual void execute_once(BESDataHandlerInterface &dhi);
101 #endif
102  virtual void execute_current(BESDataHandlerInterface &dhi);
103 
104  virtual void dump(std::ostream &strm) const;
105 
106  static BESRequestHandlerList *TheList();
107 };
108 
109 #endif // I_BESRequestHandlerList_h
110 
Structure storing information used by the BES to handle the request.
top level BES object to house generic methods
Definition: BESObj.h:50
The list of registered request handlers for this server; a singleton.
virtual void execute_all(BESDataHandlerInterface &dhi)
for all of the registered request handlers, execute the given request
virtual std::string get_handler_names()
Returns a comma separated string of request handlers registered with the server.
virtual void dump(std::ostream &strm) const
dumps information about this object
virtual bool add_handler(const std::string &handler_name, BESRequestHandler *handler)
add a request handler to the list of registered handlers for this server
virtual BESRequestHandler * remove_handler(const std::string &handler_name)
remove and return the specified request handler
virtual Handler_citer get_last_handler()
return a constant iterator pointing to the end of the list
virtual void execute_current(BESDataHandlerInterface &dhi)
Execute a single method for the current container that will fill in the response object rather than i...
virtual void execute_each(BESDataHandlerInterface &dhi)
for each container in the given data handler interface, execute the given request
virtual Handler_citer get_first_handler()
return an iterator pointing to the first request handler in the list
virtual BESRequestHandler * find_handler(const std::string &handler_name)
find and return the specified request handler
Represents a specific data type request handler.