bes  Updated for version 3.17.0
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 using std::map ;
40 using std::string ;
41 
42 #include "BESObj.h"
43 #include "BESDataHandlerInterface.h"
44 
45 typedef bool (*p_request_handler)(BESDataHandlerInterface &);
46 #define BES_REQUEST_HANDLER_CATCH_ALL "catch_all"
47 
73 class BESRequestHandler : public BESObj
74 {
75 private:
76  map< string, p_request_handler > _handler_list ;
77  string _name ;
78 public:
79  BESRequestHandler( const string &name )
80  : _name( name ) {}
81  virtual ~BESRequestHandler(void) {}
82 
83  typedef map< string, p_request_handler >::const_iterator Handler_citer ;
84  typedef map< string, p_request_handler >::iterator Handler_iter ;
85 
86  virtual const string & get_name( ) const { return _name ; }
87 
88  virtual bool add_handler( const string &handler_name,
89  p_request_handler handler_method ) ;
90  virtual bool remove_handler( const string &handler_name ) ;
91  virtual p_request_handler find_handler( const string &handler_name ) ;
92 
93  virtual string get_handler_names() ;
94 
95  virtual void dump( ostream &strm ) const ;
96 };
97 
98 #endif // I_BESRequestHandler_h
99 
virtual string get_handler_names()
return a comma separated list of response object types handled by this request handler ...
Base object for bes objects.
Definition: BESObj.h:52
Represents a specific data type request handler.
Structure storing information used by the BES to handle the request.
virtual bool add_handler(const string &handler_name, p_request_handler handler_method)
add a handler method to the request handler that knows how to fill in a specific response object ...
virtual bool remove_handler(const string &handler_name)
remove the specified handler method from this request handler
virtual void dump(ostream &strm) const
dumps information about this object
virtual p_request_handler find_handler(const string &handler_name)
find the method that can handle the specified response object type