bes
Updated for version 3.17.0
|
maintains the list of registered request handlers for this server More...
#include <BESRequestHandlerList.h>
Public Types | |
typedef map< string, BESRequestHandler * >::const_iterator | Handler_citer |
typedef map< string, BESRequestHandler * >::iterator | Handler_iter |
Public Member Functions | |
virtual bool | add_handler (const string &handler_name, BESRequestHandler *handler) |
add a request handler to the list of registered handlers for this server More... | |
virtual void | dump (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 void | execute_once (BESDataHandlerInterface &dhi) |
Execute a single method that will fill in the response object rather than iterating over the list of containers or request handlers. More... | |
virtual BESRequestHandler * | find_handler (const 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 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 string &handler_name) |
remove and return the specified request handler More... | |
Static Public Member Functions | |
static BESRequestHandlerList * | TheList () |
For a type of data to be handled by the BES the data type must registered a request handler with the server. This request handler knows how to fill in specific response objects, such as DAS, DDS, help, version, etc... The request handlers are registered with this request handler list.
Definition at line 54 of file BESRequestHandlerList.h.
|
virtual |
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 49 of file BESRequestHandlerList.cc.
References find_handler().
|
virtual |
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 294 of file BESRequestHandlerList.cc.
References BESRequestHandler::dump().
|
virtual |
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 186 of file BESRequestHandlerList.cc.
References BESDataHandlerInterface::action, BESRequestHandler::find_handler(), get_first_handler(), and get_last_handler().
|
virtual |
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 239 of file BESRequestHandlerList.cc.
References BESContainer::access(), BESDataHandlerInterface::action, BESDataHandlerInterface::container, BESDataHandlerInterface::data, find_handler(), BESRequestHandler::find_handler(), BESContainer::get_container_type(), and BESContainer::get_real_name().
|
virtual |
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 162 of file BESRequestHandlerList.cc.
References BESDataHandlerInterface::container, execute_current(), BESDataHandlerInterface::first_container(), and BESDataHandlerInterface::next_container().
|
virtual |
This method is for requests of a single type of data. The request is passed off to the request handler for the first container in the data handler interface. It is up to this request handlers method for the specified response object type to fill in the response object. It can iterate over the containers in the data handler interface, for example.
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 first containers data type or if the request handler cannot fill in the specified response object. |
Definition at line 217 of file BESRequestHandlerList.cc.
References execute_current(), and BESDataHandlerInterface::first_container().
|
virtual |
handler_name | name of the data type request handler |
Definition at line 90 of file BESRequestHandlerList.cc.
|
virtual |
Definition at line 107 of file BESRequestHandlerList.cc.
|
virtual |
Definition at line 129 of file BESRequestHandlerList.cc.
|
virtual |
Definition at line 117 of file BESRequestHandlerList.cc.
|
virtual |
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 responsability 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 71 of file BESRequestHandlerList.cc.