bes  Updated for version 3.20.6
BESRequestHandler.h
1 // BESRequestHandler.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_BESRequestHandler_h
34 #define I_BESRequestHandler_h 1
35 
36 #include <map>
37 #include <string>
38 
39 #include "BESObj.h"
40 #include "BESDataHandlerInterface.h"
41 
47 typedef bool (*p_request_handler_method)(BESDataHandlerInterface &);
48 
74 class BESRequestHandler: public BESObj {
75 private:
76  std::map<std::string, p_request_handler_method> _handler_list;
77  std::string _name;
78 
79 public:
80  BESRequestHandler(const std::string &name) :
81  _name(name)
82  {
83  }
84 
85  virtual ~BESRequestHandler(void)
86  {
87  }
88 
89  typedef std::map<std::string, p_request_handler_method>::const_iterator Handler_citer;
90  typedef std::map<std::string, p_request_handler_method>::iterator Handler_iter;
91 
92  virtual const std::string & get_name() const
93  {
94  return _name;
95  }
96 
97  virtual bool add_method(const std::string &name, p_request_handler_method method);
98 
101  virtual bool add_handler(const std::string &name, p_request_handler_method method)
102  {
103  return add_method(name, method);
104  }
105 
106  virtual bool remove_method(const std::string &name);
107  virtual p_request_handler_method find_method(const std::string &name);
108 
109  virtual std::string get_method_names();
110  virtual time_t get_lmt(const std::string &name);
111 
112  virtual void add_attributes(BESDataHandlerInterface &dhi);
113 
114  virtual void dump(std::ostream &strm) const;
115 };
116 
117 #endif // I_BESRequestHandler_h
BESRequestHandler
Represents a specific data type request handler.
Definition: BESRequestHandler.h:74
BESRequestHandler::find_method
virtual p_request_handler_method find_method(const std::string &name)
find the method that can handle the specified response object type
Definition: BESRequestHandler.cc:95
BESRequestHandler::get_method_names
virtual std::string get_method_names()
return a comma separated list of response object types handled by this request handler
Definition: BESRequestHandler.cc:112
BESRequestHandler::remove_method
virtual bool remove_method(const std::string &name)
remove the specified handler method from this request handler
Definition: BESRequestHandler.cc:74
BESRequestHandler::add_method
virtual bool add_method(const std::string &name, p_request_handler_method method)
add a handler method to the request handler that knows how to fill in a specific response object
Definition: BESRequestHandler.cc:58
BESRequestHandler::add_handler
virtual bool add_handler(const std::string &name, p_request_handler_method method)
Backward compatibility with the older version of this class.
Definition: BESRequestHandler.h:101
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESRequestHandler::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: BESRequestHandler.cc:163
BESDataHandlerInterface
Structure storing information used by the BES to handle the request.
Definition: BESDataHandlerInterface.h:56
BESRequestHandler::get_lmt
virtual time_t get_lmt(const std::string &name)
Get the Last modified time for.
Definition: BESRequestHandler.cc:133