perfsonar development work

[Wiktor Procyk <>]

WebAdmin - Developers Guide

WebAdmin is web based tool for editing config files required to configure 
other java perfSonar services .

1. Obtaining sources and compiling

The most current version of WebAdmin is available in SVN at 
branches/new-structure-with-base2/ps-mdm-web-admin

In spite it is intended to use maven in the whole perfSonar set of tools, 
WebAdmin still uses ant script. To properly compile and build working war 
package it is required to run "get-repo" and then "prepare-war-structure". 
Complete structure of compiled WebAdmin is placed in build directory

2. Structure of WA application

\
 |-META-INF
 |-wa
 |-WEB-INF
 |   |-classes
 |   |   |-perfsonar
 |   |   |   \ conf
 |   |   |      |-configuration.xml
 |   |   |      \ webAdminConfig.xml
 |   |   \ log4j.properties
 |   |-lib
 |   \ web.xml
 \ index.jsp


Directory/files tree above presents main path/files which have to be accessed 
during integration.

3. Integration with other perfSonar java service

3a. Required files

To integrate WebAdmin with other java perfsonar service it is required to 
copy to its structure following directories/files:
- directory \wa
- directory \WEB-INF\classes\perfsonar
- directory \WEB-INF\lib
- file index.jsp

Please be careful and NOT overwrite your own log4j settings by just copying 
\WEB-INF\classes\log4j.properties file.

In the case that WebAdmin and other java perfsonar service use the same java 
library (*.jar file located in \WEB-INF\lib) copying can cause warnings 
notifying about overwriting file - it is nothing wrong when such a message 
occurs.
It is recommended to check if the same library does NOT occur two times with 
different versions numbers; in such case the older one should be deleted, 
because it cane cause some errors and instability.

3b. Required changes

WebAdmin is supposed to be used for editing configuration file of other java 
perfsonar service - this file is 
\WEB-INF\classes\perfsonar\conf\configuration.xml . To tailor WebAdmin to 
specyfic java perfsonar service needs it is required to edit 
\WEB-INF\classes\perfsonar\conf\webAdminConfig.xml . This file is responsible 
for the structure of forms on the web (links Service settings and Advanced 
service settings). It contains also valid username and password used to 
initial authorization. Default parameters values should be placed in 
configuration.xml file. Every time setting webpage is requested basing on 
webAdminConfig.xml file form is build and filled in with values from 
configuration.xml file. After editing when we press Submit button 
configuration.xml file is rewriten to reflect made changes.
It is also required to concatenate contents of web.xml files in both services 
(WebAdmin and other java perfsonar service) and put the result in the 
structure of other java perfsonar service. By concatenating I mean to copy 
all the text between <webapp> and </webapp> marks from WebAdmin 
\WEB-INF\web.xml file and paste copied text before closing </webapp> mark in 
other java perfsonar service in \WEB-INF\web.xml file.