Configuration and Installation of VSWAP2

Contents:

1. Introduction

2. Pre-requisites

2.1 Hardware Requirements

2.2 Apache Web Server / Tomcat Servlet Container

2.3 Java

2.4 Java Servlets

2.5 3rd-Party Java Archives (Jar files)

2.6 Password verification / identification of Users

3. Installation of Download Version of VSWAP2

3.1 Installation of VSWAP on Unix/Linux

3.2 Installation of VSWAP on Windows

3.3 Post Installation

4. Configuring the Test Suite

4.1 Setting your CLASSPATH environment variable

4.2 Configuring the Required Parameters

4.3 Modifying Configuration Parameters

4.4 Executing the Configuration Tool

4.5 Accessing VSWAP

5. Protocol / Application Integration

5.1 Configuration Parameters used for Protocol/Application Test Suite Integration

5.2 Creating IP Address Allocation Files

5.3 Removing IP Address Allocations

6. Integration with Apache Web Server and Tomcat

7. The Log File

8. Reporting Problems

1.  Introduction

This HTML file describes the installation and configuration procedures required for the VSWAP2 download version.  It also describes the configuration required for integrating VSWAP with the Active Relay (provided by NCC Global).

VSWAP is implemented in Java.  And is designed to operate as a Servlet Web Application that is operated within a Servlet Container environment, please see http://java.sun.com/products/servlet/index.html for details of the Java Servlet environment and Web Applications.

These instructions are designed for use with the Apache Web Server version 1.3.20 or greater, Tomcat Servlet Container version 3.2.3 or greater and the Apache module mod_jk.

VSWAP2 is known to work on the following hardware platforms/software combinations:


2. Pre-requisites

The VSWAP test suite is implemented entirely in Java, it also uses XML for the tests within the test suite and XML for ALL configuration data held within the test suite.  It also uses Java Servlets to provide the User Interface.  As such it requires a number of different technologies to function correctly.  VSWAP is also configured as a Web Application for use within a Servlet Container and is tailored towards the use of Apache Web Server ,Jakarta Tomcat and mod_jk as the communication module, it is possible however to not use these technologies.
 

2.1  Hardware Requirements

There are no specific hardware requirements for VSWAP.
 

2.2  Apache Web Server / Tomcat Servlet Container

VSWAPs configuration tool is designed to produce configuration files that are suitable for use directly within Apache and Tomcat.  If you are not using Tomcat and/or Apache then please see your vendors documentation for on how to configure and install a Web Application for use within a Servlet Container.

If you are using Apache Web Server/Tomcat then it is recommended that you use at least Apache 1.3.20, Tomcat 3.2.3 or Tomcat 3.3 and mod_jk.  Please see the Apache and Tomcat web sites for details on how to configure/install those technologies.  Please note that at this time VSWAP has NOT been tested using Tomcat 4.0.2 or Apache 2.0.

It is recommended that you use ajp13 as the communication protocol between Apache and Tomcat, the VSWAP configuration tool will generate an Apache configuration file that is tailored for ajp13 and mod_jk.  You must ensure that you have a worker configured for the ajp13.
 

2.3  Java

You must have at least the Java JRE installed on the same machine that VSWAP is to be installed on.  VSWAP requires that you use at least Java 1.3.  Please see http://java.sun.com/ for details of how to acquire Java for your platform.
 

2.4  Java Servlets

VSWAPs interface to the User is via Java Servlets.  VSWAP requires a minimum of Java Servlets 2.2 to function correctly.  You should use a Servlet Container that is Java Servlet 2.2 compliant.
 

2.5 3rd-Party Java Archives (Jar files)

The following is a list of Java Archives as provided by 3rd-Party vendors that are required by VSWAP.  Please note that VSWAP will NOT start if these pacakges are not available.  They are freely available.  Each of the Jar files should be placed into either the Servlet Containers library directory and made globally available to all Web Applications (/lib in the case of Tomcat 3.2.3) or a WEB-INF/lib directory should be created in the VSWAP_INSTALLATION_DIR directory and then the Jar files should be placed in there.  It is recommended that you place the jar files in the WEB-INF/lib directory.  Please note that each of the locations given below will take you to a web site where you can download the overall package in use, you should then install the package and extract the relevant Jar file, the exact location of the Jar file within the package is NOT given since it is subject to change on the part of the vendor.

You must respect any and all licensing conditions and terms of use as required by each of the 3rd party vendors.

Please note that the URLs given below are accurate at the time of writing (29/October/2001).
 

Table 1: 3rd-Party Java Archives
Product Name
Location of file
Notes
Jar file name
JavaMail
 http://java.sun.com/products/javamail/index.html
 Need version 1.2, file javamail-1_2.zip.
mail.jar
JavaBeans Activation Framework
 http://java.sun.com/products/javabeans/glasgow/jaf.html
 Need version 1.0.1, file jaf1_0_1.zip.
activation.jar
JDOM
 http://www.jdom.org/dist/binary
 Need version 7, file jdom-b7.tar.gz or jdom-b7.zip.
jdom.jar
Xerces XML Parser
 http://xml.apache.org/dist/xerces-j
 Need version 1.2.3, file Xerces-J-bin.1.2.3.tar.gz.  There are issues with the use of version higher than 1.2.3 with JDOM 7.
xerces.jar
Cryptix
 http://www.cryptix.com/products/cryptix31/index.html#download
 Need version 3.2.0, file cryptix32-20001002-r3.2.0.zip.
cryptix32.jar

2.6  Password verification / identification of Users

VSWAP uses passwords to identify a User within the system, this means that the Java software call to:
HttpServletRequest.getRemoteUser ()
must NOT return null.  This means that you must ensure that your Web Server requires Users to "log-in" (i.e. provide a valid username/password combination).  VSWAP will create users within the system via the user of the "CreateUser" Servlet, if will also then update the file [VSWAP_INSTALLATION_DIR]/passwds/.htpasswd with the username and if you are running on a Unix machine an encrypted value for the password, the format of the .htpasswd file is suitable for use with the Apache module mod_auth.  If you are running VSWAP on a Windows machine then the password will NOT be encrypted.


 

3.  Installation of Download Version of VSWAP2

The VSWAP release is provided as a gzipped tar (Tape Archive) file.  In general the name of the file is: vswap2_XX.tar.gz.

The file was created on Solaris 2.8 using the GNU gzip program version 1.3 and the GNU tar program version 1.13.

VSWAP is designed to be installed in a single directory, with all data needed by VSWAP being held in sub-directories within the installation directory (this will be referred to throughout the document as [VSWAP_INSTALLATION_DIR]).  Note: the directory must be accessible from your Web Server.
 

3.1  Installation of VSWAP on Unix/Linux

To install VSWAP on Unix/Linux execute the following commands:

    mkdir [VSWAP_INSTALLATION_DIR]

where [VSWAP_INSTALLATION_DIR] is the name of the directory that you want VSWAP to be installed to, for example: /usr/local/vswap/vswap2

Then place the vswap2_XX.tar.gz file into the [VSWAP_INSTALLTION_DIR]:

    mv vswap2_XX.tar.gz [VSWAP_INSTALLATION_DIR]

    gzip -d vswap2_XX.tar.gz
    tar xf vswap2_XX.tar

This will then expand the archive into the directory.
 

3.2  Installation of VSWAP on Windows

To install VSWAP on Windows a tool must be used that understands compressed archive formats such as tar.gz.  WinZip is one such tool.

You should create the VSWAP installation directory [VSWAP_INSTALLATION_DIR] and then extract the archive to that directory.
 

3.3  Post Installation

There should be the following directories/files in the [VSWAP_INSTALLATION_DIR].

    WEB-INF
    conf
    data
    interface
    logs
    passwds
    templates
    testinfo
    testrecords
    tools
    vswapProperties.baseproperties

You should check the permissions of the logs, passwds and testrecords directories, they must be writable by the User that executes the Servlet Container.

It is strongly recommended that you do NOT execute the Servlet Container as the super user (on Unix) or as an Administrator (on Windows).

Note: a common gotcha is that the WEB-INF and WEB-INF/classes directories do not have execute permissions for the User who executes the Servlet Container, if this occurs then VSWAP will not be able to start because the Servlet Container will not be able to find/load the InitSystem servlet.  You must also ensure that the logs, passwds and testrecords directories are writable by the User who executes the Servlet Container.


 

4.  Configuring the Test Suite

Please note:

4.1  Setting your CLASSPATH environment variable

You must ensure that the following Jar files are in your CLASSPATH environment variable prior to executing the VSWAP configuration tool:
  You must also ensure that the following directories are added to your CLASSPATH:

    [VSWAP_INSTALLATION_DIR]/WEB-INF/classes

and:

    [VSWAP_INSTALLATION_DIR]/tools
 

4.2  Configuring the Required Parameters

The file [VSWAP_INSTALLATION_DIR]/vswapProperties.baseproperties contains the properties that are modifiable within VSWAP.  However only a subset of these parameters should be modified and only those listed below are supported by The Open Group.  Please note that no support is provided whatsoever for the modification of none supported parameters.

It should be noted that the vswapProperties.baseproperties file contains a number of parameters that are not listed below, please note that these parameters should NOT be modified.  They are used mainly for configuration of the Test Suite.  Please note that The Open Group does not provide support for the configuration of a downloaded Test Suite, if you wish to purchase support for the download version please contact: vswap-help@opengroup.org
 

Table 2: Basic Configuration Parameters
Parameter Name
Description
Valid Values
vswapname
 This is the name of the Test Suite, in general it better to have this the same as [VSWAP_INSTALLATION_DIR] however this is not mandated.  This parameter should be set once and NOT modified for the life-time of the Test Suite release, modifying this parameter AFTER VSWAP has been started can cause errors to occur. Any, it is set initially to "vswap2".
basedir
 This tells VSWAP where it lives in the file system, this is needed for creating the configuration files and creating User test sessions and the log.  All directories within VSWAP are configured to be sub-directories of this directory by default. Any, it is set initially to "/usr/local/vswap2/".

However it must be a valid directory within the file system, NFS mounts are possible for Unix installations and for mapped Network drives for Windows installations.

Note that this parameter MUST be provided AND must be a fully qualified path within the file system, it cannot be a relative path.

You MUST ensure that this parameter has a trailing / on the end of it's value.  Please note this should be / regardless of whether you have installed on Unix or Windows.
HttpServerName
 This is the name of the machine that is hosting VSWAP, this should be a fully qualified DNS name or IP address that is available on your network, for example www.opengroup.org or 10.10.10.100.  If you are running VSWAP on a different port, i.e. other than 80 then this should also be appended to the end of this parameter, i.e. www.opengroup.org:10000.

This parameter is the basis for the URLs that are used within the Test Suite and are selected by the User via their browser.

 Any, it is set initially to "localhost".

However this must be a valid IP address or DNS name that can be resolved by Clients of the Test Suite.

Note that this parameter MUST be provided AND must contain the port number to use if VSWAP is running on any port other than 80.
baseurl
 This is the basic URL that is used within the Test Suite, it is also the URL to access the Test Suite for HTML and WML Clients.

Note modifying this parameter has an impact on the configuration that is required for your Web Server and/or Servlet Container.

 Any, however this must have the HttpServerName parameter within it.  Set initially to "http://[HttpServerName]/[vswapname]", if it recommended that this is NOT modified. 
TestSuiteVerboseName
 A verbose name that is used on the Index page. Any, it is set initially to "WAP 2"
TestSuiteReleaseType
 A verbose name giving information about the type of release. Any, it is set initially to "Download"
TestSuiteReleaseDate
 A verbose name indicating the date of release of the Test Suite. Any, it is set initially to "21 May 2003"
TestSuiteId
 Used in the Test Suite to indicate what release is in use. Any, it is set initially to "VSWAP2"
emailProblems
 If set to true then problems found within the Test Suite will be recorded to the log file AND an email sent to the Administrator (please see the adminemail parameter) Either true or false.  Is used in conjunction with the adminemail and smtphost parameters.  It is set initially to "false".
adminemail
 This should be an email address that is used to send problem emails to when an error occurs within the Test Suite, it is also used when VSWAP is unable to allocate an IP address, please see Protocol / Application Integration  for details of the IP address allocation) Should be a valid email address, only used if emailProblems is set to "true".
smtphost
 VSWAP uses SMTP to send emails to the adminemail address if the emailProblems parameter is set to "true".  If set this should be set to a valid smtp host within your network. Should be a valid fully qualified hostname for a SMTP host.  Only used if emailProblems is set to "true".
AJPProtocolVersion
 Used when creating the Apache configuration file. Should be either "ajp13" or "ajp12".  Set initially to "ajp13".
AdminUser
 Please see section Removing IP Address Allocations for details about this parameter. Any.  Set initially to "AdminUser".
AdminPassword
 Please see section Removing IP Address Allocations for details about this parameter. Any.  Set initially to "1234abcd".
appendToLogFile
 Used to indicate whether a new log file should be created when VSWAP is restarted or should the same log file be used.  The log file can be found in the directory [VSWAP_INSTALLATION_DIR]/logs called: [vswapname].logfile.

If set to "true" then when VSWAP is restarted any existing log file will be renamed to [vswapname].logfile.[current time in milliseconds] and a new log file created.

If set to "false" then the existing log file will be used and log messages will be appended to the file.

It is recommended that this parameter is not modified.

 Either "true" or "false".  Set initially to "true".
makeXMLPretty
 Indicates whether VSWAP should output "human readable" XML when creating/modifying User test records or should leave out unnecessary space.

This option is useful only for debugging and should not be modified.

Warning: changing this parameter to "true" can have an impact on performance and disk space usage.

 Either "true" or "false".  Set initially to "false".
compressOutputXML
 Indicates whether VSWAP should compress the XML for User test records/execution logs etc.

This option should only be used if your installation machine is severely limited for space, it should not be modified.

If you need to modify this parameter to "true" please contact the Open Group for assistance.

Warning: changing this parameter to "true" can have an impact on performance and disk space usage.

 Either "true" or "false".  Set initially to "false".
ActiveRelayIPAddressAllocationBaseFileName
 Please see Configuration Parameters used for Protocol/Application Test Suite Integration for details about this parameter. Any, this MUST be provided.  Set initially to "[VSWAP_INSTALLATION_DIR]/data/activerelayipinfo/activerelayinfo".
NCCPTSHost
 Please see Configuration Parameters used for Protocol/Application Test Suite Integration  for details about this parameter. Any, this MUST be provided.  Set initially to "localhost".
NCCPTSPort
 Please see Configuration Parameters used for Protocol/Application Test Suite Integration  for details about this parameter. Any, this MUST be provided.  Set intially to "7999".
ModeOfOperation
 Please see Configuration Parameters used for Protocol/Application Test Suite Integration  for details about this parameter. Any, this MUST be provided.  Set intially to "Both".

 

4.3  Modifying Configuration Parameters

If you modify any configuration parameter in the file: [VSWAP_INSTALLATION_DIR]/vswapProperties.baseproperties then it is recommended that you take a back-up of the original properties file prior to any modification being made.

The configuration file is written in XML, parameters are specified using the following syntax:
 

Any number of replace-property elements can be used within the value element, these can be mixed with normal textual content.  Please note that the spacing used in textual content is maintained.  The final property value is determined by replacing any replace-property elements with their value.  Each id used in a replace-property element MUST exist as a property element somewhere within the properties file.  No loop checking is performed on the property values, i.e. if you have a property that uses a replace-property element to itself no detection is performed on this.

In general you should NOT use the replace-property element.

The properties file MUST conform to the normal XML syntax and validation rules.

There is NO DTD for the properties file, error detection is performed via code.

If you need to set a parameter then place the value of the parameter between the opening <value> and closing </value> elements for that parameter.

For example to set the value of "vswapname":

<property id="vswapname">
<value>vswap2</value>
</property>
To set the value of "basedir":
<property id="basedir">
<value>/usr/local/vswap/vswap2/</value>
</property>

4.4 Executing the Configuration Tool

Before you execute the configuration tool please ensure that you have specified the required parameters as defined in the properties file.  You must also ensure that your CLASSPATH environment variable is configured correctly and that you have the java command line tool available to execute.

To configure VSWAP your current working directory should be [VSWAP_INSTALLATION_DIR] and you should execute the following command:
 

java ConfigureDownloadVSWAP vswapProperties.baseproperties
The tool will then load the properties file, and then create a number of files that are needed by VSWAP, you must ensure that you have permission to write to the [VSWAP_INSTALLATION_DIR]/conf, [VSWAP_INSTALLATION_DIR]/WEB-INF and [VSWAP_INSTALLATION_DIR]/passwds directories since files are created in those directories.

The following files are created (all directories given are relative to [VSWAP_INSTALLATION_DIR]:
 

Table 3: Files Created by the Configuration Tool
File Name
Directory
Purpose
web.xml
WEB-INF
 The file used by the Servlet Container to indicate what Servlets can be accessed for the Servlet Context.
vswapProperties.[vswapname]
conf
 The file that indicates the properties available to VSWAP, these are loaded into VSWAP at start-up time.
vswapApacheConf.[vswapname]
conf
 This file is only useful for installations that are using Apache as the Web Server and Tomcat as the Servlet Container.  If Apache is used this file indicates what directories should be protected and the password files to use to protect them.  If you are using Apache as the Web Server and Tomcat as the Servlet Container then just adding the line:

Include [VSWAP_INSTALLATION_DIR]/conf/vswapApacheConf.[vswapname] 

to your httpd.conf file will let Apache know how to communicate with Tomcat for this Servlet Context (VSWAP).
admin-passwd
passwds
 This file contains the username/password for the properties AdminUser/AdminPassword it is used to protect the Administration Servlets (see section Removing IP Address Allocations for details of the use of those parameters).  This file is only useful if your are using Apache as your Web Server, if not it can be safely removed.

If you need to modify any properties after these files have been created then you can re-execute the tool, the tool will then ask you for confirmation before overwriting any files.  Please note for any changes to take effect in VSWAP you must restart your Servlet Container.  VSWAP only loads it's configuration at start-up time.

When the configuration tool has finished it will output some text indicating what you should do next to get VSWAP running, this text is heavily biased towards Apache/Tomcat.  However the XML fragment output is required regardless of the Servlet Container used, the fragment, will take the following form:
 

<Context path=[vswapname]" docBase="[VSWAP_INSTALLATION_DIR]" crossContext="false" debug="0" reloadable="false" trusted="false" />
this fragment should be placed in the relevant place within your Servlet Container configuration file, please see your Servlet Container vendor documentation for details of this.  If you are using Tomcat then please see the Integration with Apache Web Server and Tomcat section for details of how to use that fragment with Tomcat.
 

4.5 Accessing VSWAP

Access to VSWAP can be made by using the value of property "baseurl", in general (if the property has not been modified) this will be:
 
http://[HttpServerName]/[vswapname]

or instance:

http://testing.opengroup.org/vswap2


this is the URL to use for both HTML Clients and WAP Clients, however they will see different pages.


 
 

5. Protocol / Application Integration

Please note that the Protocol Testing System is NOT provided with VSWAP, please contact your WAP Forum representative for acquiring the Protocol Test System.

To execute Protocol test sessions you must configure the test suite such that it has IP addresses available for use when Protocol testing occurs.  Please see the section on Creating IP Address Allocation Files for details of creating the IP address files required.

You must also ensure that the "ModeOfOperation" configuration parameter is set to either "ProtocolOnly" or "Both", please see the section on Configuration Parameters used for Protocol/Application Test Suite Integration for details of setting that parameter.

NOTE: Protocol testing can only occur if the Active Relay has been installed.  Please refer to the documentation provided by NCC for details of installing the Active Relay.
 

5.1 Configuration Parameters used for Protocol/Application Test Suite Integration


The configuration parameters required for Protocol/Application test suite integration are:
 

Table 4: Protocol Specific Configuration Parameters
Configuration Parameter Name
Purpose
Default value
NCCPTSHost
 This parameter indicates to VSWAP where it can "find" the Active Relay, please note that since VSWAP and the Active Relay communicate exclusively via HTTP this host must be accessible via the internet (or via local-loopback if the Active Relay is installed on the same machine as VSWAP), i.e. the value specified must be either an IP address or a DNS name that can be resolved by VSWAP, for example www.opengroup.org or 10.10.10.100.  Set initially to "localhost", you MUST specify this parameter.
NCCPTSPort
 This is the port number that the Active Relay is listening for requests from VSWAP on.  (Please see the Active Relay installation documentation for details of configuring the port number) Please note that the combination of the NCCPTSHost and NCCPTSPort configuration parameters are used when VSWAP sends requests to the Active Relay.  This value MUST be a number, no validation of the value is performed.  You MUST provide this value otherwise communication between the two will fail. Set initially to "7999", you MUST specify this parameter.
ModeOfOperation
 This indicates to VSWAP what mode of operation it should operate in.  Specifying ApplicationOnly means that only the Application level testing is required and Protocol level testing will be unavailable.  Conversely specifying ProtocolOnly will only allow Protocol testing to occur.  Specifying Both will cause both Application and Protocol level testing to be available.  Please note that this value is case sensitive. This parameter is set initially to "Both", you should only modify it if you do not wish to use either the Application or Protocol level testing facilities.
ActiveRelayIPAddressAllocationBaseFileName
 This indicates to VSWAP what the base name is of the files that hold the IP addresses that can be used for Protocol testing.  For example the basename could be: /usr/local/vswap/vswap2/data/activerelayinfo/info, in this case VSWAP will then look for files called infoco, infocl, infosco, infoscl when it needs to allocate an IP address to a Test Session.

Important note: you MUST ensure that the files produced by the CreateActiveRelayIPAddressFile tool match up with the files looked for by VSWAP.  For instance you should create files called infoco, infocl, infosco and infoscl and place them in the directory /usr/local/vswap/vswap2/data/activerelayinfo if you set this parameter to /usr/local/vswap/vswap2/data/activelrelayinfo/info.

 This parameter is set initially to "[VSWAP_INSTALLATION_DIR]/data/activerelayipinfo/allocationinfo", it should not be modified unless you need to.

5.2 Creating IP Address Allocation Files

You MUST create these files if you are going to use the Protocol testing part of VSWAP.  These files indicate to VSWAP which IP addresses are available for use in Protocol Test Sessions.  You must ensure that the IP addresses used are available for use within your network and are accessible from the Internet.

When creating the IP Address Allocation files you must ensure that where you store the files and the names of the files conform to the configuration parameter: ActiveRelayIPAddressAllocationBaseFileName, please see the table below for details of the usage and meaning of this parameter.

You should create 4 separate files, the configuration tool will only create a single file for a given WAP Service, this file is then the "master" list for all the IP addresses to be used for that service.  The 4 files should have a specific ending, either co, cl, sco or scl.  These endings are used in conjunction with the value in ActiveRelayIPAddressAllocationBaseFileNameActiveRelayIPAddressAllocationBaseFileName by VSWAP to find the correct allocation file when an IP address needs to be allocated.

So if the value of ActiveRelayIPAddressAllocationBaseFileName is:

    /usr/local/vswap/vswap2/data/activerelayinfo/info

then you should create the following files:

    /usr/local/vswap/vswap2/data/activerelayinfo/infoco
    /usr/local/vswap/vswap2/data/activerelayinfo/infocl
    /usr/local/vswap/vswap2/data/activerelayinfo/infosco
    /usr/local/vswap/vswap2/data/activerelayinfo/infoscl

To create the file you should use the Java tool in the [VSWAP_INSTALL_DIR]/tools directory.  You must ensure that your CLASSPATH environment variable is set to the correct values (please see the section on setting your CLASSPATH variable).  You should then execute the following command:

    java CreateActiveRelayIPAddressFile [WAP Service] [IP Address Range] [Output File]

where [WAP Service] is one of co, cl, sco, scl, [IP Address Range] is a range of IP addresses that are to be used for testing purposes, the format of the range should be: A.B.C.D-E, where A, B, C and positive integers in the range 1-255 and D and E are positive integers in the range 1-254.   [Output File] is the name to use when creating the file, note no automatic extensions are added, you must ensure that the filename ends correctly, i.e. co if the WAP Service is co.

For example the command:

    java CreateActiveRelayIPAddressFile co 10.10.10.100-200 infoco

will create a file named infoco in the current directory for the WAP Service Connection-Oriented (co) for all IP addresses in the range 10.10.10.100 to 10.10.10.200 inclusive.
 

5.3 Removing IP Address Allocations

There may be occasions when you need to remove the IP address allocations that have been made.  The system will send an email to the administrator if it is unable to allocate an IP address, i.e. it has run out of IP addresses to allocate, in this case you should use the CleanupActiveRelayIPAddresses servlet, accessible via [VSWAP_URL]/CleanupActiveRelayIPAddresses.  It is NOT recommended that you use this servlet unless the system indicates that it can no longer allocate IP addresses to test sessions.

If you are using Apache and have used the Apache configuration file generated by the ConfigureDownloadVSWAP tool then access to this servlet will be protected.  This protection can be configured via the following 2 configuration parameters:
 
 

Configuration Parameter Name
Purpose
Default Value
AdminUser
 Controls access to administration Servlets.  Is the username to provide when accessing the protected Servlets. Initially set to "AdminUser".
AdminPassword
 Controls access to administration Servlets.  Is the password to provide when accessing the protected Servlets. Initially set to "1234abcd".

The servlet then shows a form that should be completed and submitted to then remove the IP address allocations.  Please note that the allocations are removed from the Users test sessions AND the IP address allocation files, this information is NOT recoverable and can have an impact on Users testing.  Note the Open Group does not provide any accept any liability for the removal of IP addresses from Users test sessions.

The options on the form are:
 

Option Name
Description
WAP Service
 You should pick the WAP Service that wish to free up IP addresses for, either CO (Connection Oriented), CL (Connection Less), SCO (Secure Connection Oriented) or SCL (Secure Connection Less)
Number of days since last access
 This is the number of days since the current time since a test session was accessed/modified (via some kind of activity) by the User, this is used by the system to determine which test sessions to consider for clean-up, for example if you set this value to 30 (the default) then only test sessions that have NOT been modified for 30 days or more will be considered in the IP address cleanup.

If you set this value to 0 then it will consider ALL test sessions in the cleanup.
Email Log
 If selected then a report describing what sessions can be/were cleaned up will be sent to the administrator email address (please see the section on the Administrator email).
Report Only
 If selected then no de-allocations will be made, only a report will be generated as to which test sessions can be de-allocated.

To start the de-allocation process press the "Start Deallocation" button.  When the de-allocation process has finished a report will be returned to the screen indicating what test sessions were affected (or would be affected depending upon the value of "Report Only").


 
 

6. Integration with Apache Web Server and Tomcat

The configuration tool for VSWAP makes it very easy to integrate VSWAP with the Apache Web Server and the Tomcat Servlet Container.  The files [VSWAP_INSTALLATION_DIR]/conf/vswapApacheConf.[vswapname] can be used via an Include directive in your Apache httpd.conf configuration file, i.e.
Include [VSWAP_INSTALLATION_DIR]/conf/vswapApacheConf.[vswapname]
this file is produced by the configuration tool, please see section Executing the Configuration Tool for details of this file.

The XML fragment output by the configuration tool can be used directly in the Tomcat server.xml configuration file.  It should be placed as a child of the "ContextManager" element, the fragment takes the form:

<Context path="[vswapname]" docBase="[VSWAP_INSTALLATION_DIR]" crossContext="false" debug="0" reloadable="false" trusted="false" />

 
 

7. The Log File

All log messages produced by VSWAP are logged to the log file, this is created at start-up time and it's usual location is [VSWAP_INSTALLATION_DIR]/logs.  It is called [vswapname].logfile.  All warning, information and error messages are logged here.  The only exception to this is at start-up time when error messages are logged to the Servlet Container log file.  If, when accessing VSWAP, you see a message that states:
 
Unable to start VSWAP Test Engine for release: [vswapname].
This indicates that an error has occurred at start-up time and the error should be logged in the Servlet Container log, for Tomcat this is the "servlet.log", for other Servlet Containers please see your vendor documentation for the location of the servlet log.  The error message there should indicate where the problem lies, a common source of errors lies in the XML within the configuration files.
 


 
 

8. Reporting Problems

WAP Forum do not fund support on the download versions of VSWAP.  However if you wish to purchase consultancy on the installation and maintenance of the download version on a time and materials basis, please contact vswap-help@opengroup.org

The Open Group are NOT responsible the operation or action of any 3rd party software used by VSWAP.