bes  Updated for version 3.17.0
BESRequestHandlerList Class Reference

maintains the list of registered request handlers for this server More...

#include <BESRequestHandlerList.h>

Inheritance diagram for BESRequestHandlerList:
Inheritance graph

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 BESRequestHandlerfind_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 BESRequestHandlerremove_handler (const string &handler_name)
 remove and return the specified request handler More...
 

Static Public Member Functions

static BESRequestHandlerListTheList ()
 

Detailed Description

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.

Member Function Documentation

bool BESRequestHandlerList::add_handler ( const string &  handler_name,
BESRequestHandler handler_object 
)
virtual
Parameters
handler_namename of the data type handled by this request handler
handler_objectthe request handler object that knows how to fill in specific response objects
Returns
true if successfully added, false if already exists
See also
BESRequestHandler

Definition at line 49 of file BESRequestHandlerList.cc.

References find_handler().

void BESRequestHandlerList::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance along with information about each of the registered request handlers.

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 294 of file BESRequestHandlerList.cc.

References BESRequestHandler::dump().

void BESRequestHandlerList::execute_all ( BESDataHandlerInterface dhi)
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.

Parameters
dhidata handler interface that contains the necessary information to fill in the response object.
See also
BESDataHandlerInterface
BESRequestHandler
BESResponseObject

Definition at line 186 of file BESRequestHandlerList.cc.

References BESDataHandlerInterface::action, BESRequestHandler::find_handler(), get_first_handler(), and get_last_handler().

void BESRequestHandlerList::execute_current ( BESDataHandlerInterface dhi)
virtual

The request is passed * off to the request handler for the current container in the data handler interface.

Parameters
dhidata handler interface that contains the necessary information to fill in the response object
Exceptions
BESInternalErrorif the request handler cannot be found for the current containers data type or if the request handler cannot fill in the specified response object.
See also
BESDataHandlerInterface
BESContainer
BESResponseObject

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().

void BESRequestHandlerList::execute_each ( BESDataHandlerInterface dhi)
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.

Parameters
dhithe data handler interface that contains the list of containers to be iterated over
Exceptions
BESInternalErrorif 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.
See also
BESDataHandlerInterface
BESContainer
BESRequestHandler
BESResponseObject

Definition at line 162 of file BESRequestHandlerList.cc.

References BESDataHandlerInterface::container, execute_current(), BESDataHandlerInterface::first_container(), and BESDataHandlerInterface::next_container().

void BESRequestHandlerList::execute_once ( BESDataHandlerInterface dhi)
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.

Parameters
dhidata handler interface that contains the necessary information to fill in the response object
Exceptions
BESInternalErrorif the request handler cannot be found for the first containers data type or if the request handler cannot fill in the specified response object.
See also
BESDataHandlerInterface
BESContainer
BESResponseObject

Definition at line 217 of file BESRequestHandlerList.cc.

References execute_current(), and BESDataHandlerInterface::first_container().

BESRequestHandler * BESRequestHandlerList::find_handler ( const string &  handler_name)
virtual
Parameters
handler_namename of the data type request handler
Returns
the request handler for the specified data type, NULL if not found
See also
BESRequestHandler

Definition at line 90 of file BESRequestHandlerList.cc.

BESRequestHandlerList::Handler_citer BESRequestHandlerList::get_first_handler ( )
virtual
Returns
a constant iterator pointing to the first request handler in the list
See also
BESRequestHandler

Definition at line 107 of file BESRequestHandlerList.cc.

string BESRequestHandlerList::get_handler_names ( )
virtual
Returns
comma separated string of request handler names registered with the server.
See also
BESRequestHandler

Definition at line 129 of file BESRequestHandlerList.cc.

BESRequestHandlerList::Handler_citer BESRequestHandlerList::get_last_handler ( )
virtual
Returns
a constant iterator pointing to the end of the list
See also
BESRequestHandler

Definition at line 117 of file BESRequestHandlerList.cc.

BESRequestHandler * BESRequestHandlerList::remove_handler ( const string &  handler_name)
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

Parameters
handler_namename of the data type request handler to be removed and returned
Returns
returns the request handler if found, NULL otherwise
See also
BESRequestHandler

Definition at line 71 of file BESRequestHandlerList.cc.


The documentation for this class was generated from the following files: