bes  Updated for version 3.17.4
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 
39 using std::map ;
40 using std::string ;
41 
42 #include "BESObj.h"
43 #include "BESDataHandlerInterface.h"
44 
45 class BESRequestHandler ;
46 
55 {
56 private:
57  static BESRequestHandlerList * _instance ;
58  map< string, BESRequestHandler * > _handler_list ;
59 protected:
60  BESRequestHandlerList(void) {}
61 public:
62  virtual ~BESRequestHandlerList(void) {}
63 
64  typedef map< string, BESRequestHandler * >::const_iterator Handler_citer ;
65  typedef map< string, BESRequestHandler * >::iterator Handler_iter ;
66 
67  virtual bool add_handler( const string &handler_name,
68  BESRequestHandler * handler ) ;
69  virtual BESRequestHandler * remove_handler( const string &handler_name ) ;
70  virtual BESRequestHandler * find_handler( const string &handler_name ) ;
71 
72  virtual Handler_citer get_first_handler() ;
73  virtual Handler_citer get_last_handler() ;
74 
75  virtual string get_handler_names() ;
76 
77  virtual void execute_each( BESDataHandlerInterface &dhi ) ;
78  virtual void execute_all( BESDataHandlerInterface &dhi ) ;
79  virtual void execute_once( BESDataHandlerInterface &dhi ) ;
80  virtual void execute_current( BESDataHandlerInterface &dhi );
81 
82  virtual void dump( ostream &strm ) const ;
83 
84  static BESRequestHandlerList *TheList() ;
85 };
86 
87 #endif // I_BESRequestHandlerList_h
88 
virtual Handler_citer get_first_handler()
return an iterator pointing to the first request handler in the list
virtual void dump(ostream &strm) const
dumps information about this object
virtual bool add_handler(const string &handler_name, BESRequestHandler *handler)
add a request handler to the list of registered handlers for this server
maintains the list of registered request handlers for this server
Base object for bes objects.
Definition: BESObj.h:52
virtual BESRequestHandler * find_handler(const string &handler_name)
find and return the specified request handler
virtual void execute_each(BESDataHandlerInterface &dhi)
for each container in the given data handler interface, execute the given request ...
virtual void execute_all(BESDataHandlerInterface &dhi)
for all of the registered request handlers, execute the given request
virtual void execute_once(BESDataHandlerInterface &dhi)
Execute a single method that will fill in the response object rather than iterating over the list of ...
virtual string get_handler_names()
Returns a comma separated string of request handlers registered with the server.
Represents a specific data type request handler.
Structure storing information used by the BES to handle the request.
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 BESRequestHandler * remove_handler(const string &handler_name)
remove and return the specified request handler