bes  Updated for version 3.20.6
BESResponseHandlerList.h
1 // BESResponseHandlerList.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_BESResponseHandlerList_h
34 #define I_BESResponseHandlerList_h 1
35 
36 #include <map>
37 #include <string>
38 
39 #include "BESObj.h"
40 
41 class BESResponseHandler;
42 
43 typedef BESResponseHandler * (*p_response_handler)(const std::string &name);
44 
60 private:
61  static BESResponseHandlerList * _instance;
62  std::map<std::string, p_response_handler> _handler_list;
63 
64  friend class resplistT;
65 
66 protected:
68  {
69  }
70 
71 public:
72  virtual ~BESResponseHandlerList(void)
73  {
74  }
75 
76  typedef std::map<std::string, p_response_handler>::const_iterator Handler_citer;
77  typedef std::map<std::string, p_response_handler>::iterator Handler_iter;
78 
79  virtual bool add_handler(const std::string &handler, p_response_handler handler_method);
80  virtual bool remove_handler(const std::string &handler);
81  virtual BESResponseHandler * find_handler(const std::string &handler);
82 
83  virtual std::string get_handler_names();
84 
85  virtual void dump(std::ostream &strm) const;
86 
87  static BESResponseHandlerList * TheList();
88 };
89 
90 #endif // I_BESResponseHandlerList_h
91 
BESResponseHandlerList
List of all registered response handlers for this server.
Definition: BESResponseHandlerList.h:59
BESResponseHandlerList::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESResponseHandlerList.cc:136
BESResponseHandlerList::remove_handler
virtual bool remove_handler(const std::string &handler)
removes a response handler from the list
Definition: BESResponseHandlerList.cc:74
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESResponseHandlerList::find_handler
virtual BESResponseHandler * find_handler(const std::string &handler)
returns the response handler with the given name from the list
Definition: BESResponseHandlerList.cc:97
BESResponseHandler
handler object that knows how to create a specific response object
Definition: BESResponseHandler.h:77
BESResponseHandlerList::get_handler_names
virtual std::string get_handler_names()
returns the comma separated list of all response handlers currently registered with this server.
Definition: BESResponseHandlerList.cc:116
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