Server implementation

The Bookkeeping server is based on a piece of python code providing both an XMLRPC server and a web server. This code was initially used in the Production system and was reused with no change in the Bookkeeping. It is implemented in file python/gaudiweb.py of the Bookkeeping package. The server is then customized in file python/BookkeepingServer.py of the Bookkeeping package.

The server handles essentially three things : webpages, servlets and XMLRPC services. The webpages and XMLRPC services just need to be registered to become available, as you can see in methods startBookkeepingWeb and startRPCServices. Most of the functionnalities is actually provided by the underlying gaudiweb server.

For the servlets, the situation is a bit more complex since this concept is java specific and thus not available in python. For this purpose, the Bookkeeping server can actually not run using a regular python implementation. It actually needs Jython, a java implementation of python. On top of that, dedicated classes were defined to handle servlets correctly, reusing the gaudiweb.Service mechanism.

This servlet support is 70% of the code of BookkeepingServer.py. It uses some home made, dummy implementation of a servlet engine provided in the calsses DummyServletConfig, DummyServletResponse and DummyServletRequest. However ever, the servelt engine could be droped as soon as the servlets are hosted by an external web server, like apache or the ORACLE one.

To conclude with the Bookkeeping server, here is the list of entry points in the current server as well as their type and usage.

• Main : A servlet building the main bookkeeping web page, i.e. the one for selecting data. See section .
• EvtTypes : A servlet building a list of existing event types. The types for which no events can be found are not listed. See section .
• EvTypeInfo : A servlet handling the selection of data and building a web page with the results See section .
• DataSets : ? Francoise, could you put something here ?
• Select A Servlet allowing to browse the database. See section .
• NewConfirm : A Servlet to enter data into the database. See section .
• DisplayBookFile : A servlet that displays details of database modification requests. See section .
• Manager : A python servlet allowing to shutdown the server from a web interface. See section .
• Bookkeeping : A directory containing files used by the generated html pages. Essentially javascripts files.
• images : A directory containing images used by the generated html pages.
• RPC/BookkeepingSvc : An XMLRPC service providing the Bookkeeping API. See section 1.4.
• RPC/BookkeepingQuery : An XMLRPC service providing the BookkeepingQuery API. This API allows to select files from the Bookkeeping. See section .
• RPC/GetLogFiles : An XMLRPC service providing easy access to log files. See section .