bes
Updated for version 3.20.6
|
The list of registered request handlers for this server; a singleton. More...
#include <BESRequestHandlerList.h>
Public Types | |
typedef std::map< std::string, BESRequestHandler * >::const_iterator | Handler_citer |
typedef std::map< std::string, BESRequestHandler * >::iterator | Handler_iter |
Public Member Functions | |
virtual bool | add_handler (const std::string &handler_name, BESRequestHandler *handler) |
add a request handler to the list of registered handlers for this server More... | |
virtual void | dump (std::ostream &strm) const |
dumps information about this object More... | |
virtual void | execute_all (BESDataHandlerInterface &dhi) |
for all of the registered request handlers, execute the given request More... | |
virtual void | execute_current (BESDataHandlerInterface &dhi) |
Execute a single method for the current container that will fill in the response object rather than iterating over the list of containers or request handlers. More... | |
virtual void | execute_each (BESDataHandlerInterface &dhi) |
for each container in the given data handler interface, execute the given request More... | |
virtual BESRequestHandler * | find_handler (const std::string &handler_name) |
find and return the specified request handler More... | |
virtual Handler_citer | get_first_handler () |
return an iterator pointing to the first request handler in the list More... | |
virtual std::string | get_handler_names () |
Returns a comma separated string of request handlers registered with the server. More... | |
virtual Handler_citer | get_last_handler () |
return a constant iterator pointing to the end of the list More... | |
virtual BESRequestHandler * | remove_handler (const std::string &handler_name) |
remove and return the specified request handler More... | |
Static Public Member Functions | |
static BESRequestHandlerList * | TheList () |
The list of registered request handlers for this server; a singleton.
For a type of data to be read by the BES, there must be a request handler that can read those data. Typically, a request handler reads information from files stored on the computer running the BES, although it is possible for a request handler to read data from remote machines, other data services, relational databases, et cetera.
Instances of BESRequestHandler use the BESDataHandlerInterface object to get a ResponseObject that they then 'fill in' with the 'requested' information. The ResponseObject holds instances of other objects like DAS, DDS, DMR, or version.
The request handlers are registered with this request handler list using a short std::string as the key value. Other parts of the BES can access this singleton class to find a specific handler using that std::string.
file_handler()
method. Definition at line 70 of file BESRequestHandlerList.h.
|
virtual |
add a request handler to the list of registered handlers for this server
handler_name | name of the data type handled by this request handler |
handler_object | the request handler object that knows how to fill in specific response objects |
Definition at line 54 of file BESRequestHandlerList.cc.
|
virtual |
dumps information about this object
Displays the pointer value of this instance along with information about each of the registered request handlers.
strm | C++ i/o stream to dump the information to |
Implements BESObj.
Definition at line 288 of file BESRequestHandlerList.cc.
|
virtual |
for all of the registered request handlers, execute the given request
In some cases, such as a version or help request, it is necessary to iterate over all of the registered request handlers to fill in the response object. If a request handler does not know how to fill in the response object, i.e. doesn't handle the response type, then simply move on to the next. No exception is thrown in this case.
dhi | data handler interface that contains the necessary information to fill in the response object. |
Definition at line 194 of file BESRequestHandlerList.cc.
|
virtual |
Execute a single method for the current container that will fill in the response object rather than iterating over the list of containers or request handlers.
The request is passed * off to the request handler for the current container in the data handler interface.
dhi | data handler interface that contains the necessary information to fill in the response object |
BESInternalError | if the request handler cannot be found for the current containers data type or if the request handler cannot fill in the specified response object. |
Definition at line 251 of file BESRequestHandlerList.cc.
|
virtual |
for each container in the given data handler interface, execute the given request
For some response objects it is necessary to iterate over all of the containers listed in the specified data handler interface. For each container, get the type of data represented by that container, find the request handler for that data type, find the method within that request handler that knows how to handle the response object to be filled in, and execute that method.
dhi | the data handler interface that contains the list of containers to be iterated over |
BESInternalError | if any one of the request handlers does not know how to fill in the specified response object or if any one of the request handlers does not exist. |
Definition at line 167 of file BESRequestHandlerList.cc.
|
virtual |
find and return the specified request handler
handler_name | name of the data type request handler |
Definition at line 95 of file BESRequestHandlerList.cc.
|
virtual |
return an iterator pointing to the first request handler in the list
Definition at line 112 of file BESRequestHandlerList.cc.
|
virtual |
Returns a comma separated string of request handlers registered with the server.
Definition at line 134 of file BESRequestHandlerList.cc.
|
virtual |
return a constant iterator pointing to the end of the list
Definition at line 122 of file BESRequestHandlerList.cc.
|
virtual |
remove and return the specified request handler
Finds, removes and returns the specified request handler. if the handler exists then it is removed from the list, but not deleted. Deleting the request handler is the responsibility of the caller. The request handler is then returned to the caller. If not found, NULL is returned
handler_name | name of the data type request handler to be removed and returned |
Definition at line 76 of file BESRequestHandlerList.cc.