PageBox

This Site The Web for

Support     Home     Word

PageBox for Java

API

Demo

Background

Programming environment

Table of content

Objective Audience Assumptions Installation Linux / Unix Windows Organization IDE setting Linux / Unix Windows Eclipse JWSDP stubs Linux / Unix JWSDP 1.3 JWSDP 1.5 Windows JWSDP 1.3 JWSDP 1.5 Axis stubs Linux Windows PageBox for JWSDP Linux / Unix PageBoxLib PageBox Repository Windows PageBoxLib PageBox Repository PageBox for Tomcat/Axis Linux / Unix PageBoxLib PageBox Repository Windows PageBoxLib PageBox Repository Pandora for JWSDP Linux / Unix Windows Pandora for Tomcat/Axis Linux / Unix Windows Production of Epimetheus Linux / Unix Windows Production of euroLCC Linux / Unix Windows Production of Prometheus Linux / Unix Windows

In this document we present the programming environment of PageBox for Java.

It may help you to start contributing to the PageBox development or to create a customized version of PageBox.

System programmers with knowledge of J2EE.

We assume that you have downloaded:

• The Sun JDK 1.4. You can download the JDK (or J2SE SDK as it is called now) from http://java.sun.com/j2se/1.4/download.html.

• The Java Web Services Developer pack (JWSDP). JWSDP 1.3 is "an all-in-one download containing key technologies to simplify building of Web services using the Java 2 Platform." JWSDP 1.5 does not include the servlet container. You can download a suitable version of Tomcat from http://java.sun.com/webservices/containers/tomcat_for_JWSDP_1_5.html. You can download the Java JWSDP itself from http://java.sun.com/webservices/downloads/webservicespack.html.

• Tomcat 4 or Tomcat 5

• Ant 1.6

• Xalan 2.5

• COS, the com.oreilly.servlet package written by Jason Hunter for the Web archive upload (MultipartRequest class).

• A Java IDE such as Eclipse 2 or 3.

You can download the PageBox programming environment from here.

Inflate the PageBox programming environment archive (pageboxPgm.jar).

Adapt the setenv.sh script to your environment. Here is an example:

setenv.sh adds the JDK path to the PATH, setup JAVA_HOME and two other variables, PBHOME and PRODUCTDIR. You can call setenv.sh from your login script or add the content of setenv.sh to your login script. PageBox scripts have been tested on Linux with bash but they should also work with ksh and with the Bourne shell.

PRODUCTDIR is the directory in which products used by PageBox should be installed:

1. COS in $PRODUCTDIR/cos

2. JWSDP 1.3 in $PRODUCTDIR/jwsdp-1.3 or

3. JWSDP 1.5 in $PRODUCTDIR/jwsdp-1.5 and Tomcat for JWSDP 1.5 in $PRODUCTDIR/tomcat50-jwsdp

4. Tomcat 4 in $PRODUCTDIR/jakarta-tomcat-4.1.31 or Tomcat 5 in $PRODUCTDIR/jakarta-tomcat-5.0.28 and Axis in $PRODUCTDIR/axis-1_1, Xalan in $PRODUCTDIR/xalan-j_2_5_2, Ant in $PRODUCTDIR/apache-ant-1.6.1.

PBHOME is the directory in which you inflate the PageBox programming environment (pageboxPgm.jar).

If you don’t want to modify scripts and ant files you must

• Install the JDK in \ j2sdk1.4.2_03

• Inflate pageboxPgm.jar in \linux

• Install COS in \cos

• Install JWSDP 1.3 in \jwsdp-1.3 or install JWSDP 1.5 in \jwsdp-1.5 and Tomcat for JWSDP in tomcat50-jwsdp or

• Install Tomcat 4 in \jakarta-tomcat-4.1.31 or Tomcat 5 in \ Tomcat 5.0.28, Axis in \axis-1_1, Ant in \apache-ant-1.6.1 and Xalan in \ xalan-j_2_5_2

Configure the IDE with the following projects:

You must also include the JWSDP archives in all projects.

Configure the IDE with the following project directories:

You must also include the JWSDP archives in JWSDP projects and the Xalan, Xerces, Axis and Tomcat archives in Tomcat/Axis projects.

In case of Eclipse 2 click on File | New | Project... and select Java. Then uncheck Use default and enter the Project name and Directory:

To set the project CLASSPATH, click on the project properties and select the Libraries tab to enter the archive paths:

If you modify the Web services’ interfaces you must regenerate the stub archives. Note that you need to regenerate for IDE needs: stubs are generated in production scripts.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts and configuration files. The scripts are defined in $PBHOME/stubs.

A script build.sh calls pageboxClt.sh, pageboxServ.sh, repositoryClt.sh and repositoryServ.sh and generates all PageBox stubs.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts and configuration files. The scripts are defined in $PBHOME/stubsjwsdp-1.5.

A script build.sh calls pageboxClt.sh, pageboxServ.sh, repositoryClt.sh and repositoryServ.sh and generates all PageBox stubs.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts and configuration files. The scripts are defined in \linux\stubs.

A script build.bat calls pageboxClt.bat, pageboxServ.bat, repositoryClt.bat and repositoryServ.bat and generates all PageBox stubs.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts and configuration files. The scripts are defined in \linux\stubsjwsdp-1.5.

A script build.bat calls pageboxClt.bat, pageboxServ.bat, repositoryClt.bat and repositoryServ.bat and generates all PageBox stubs.

We use a starter project whose directory is axisMini2/java.

In this project we define a package for PageBoxLib, Repository and pandora.

In these projects we copy the Web service interfaces:

Then for every interface we use the IDE to generate an implementation class that implements the Web service interface and javax.xml.rpc.server.ServiceLifecycle and a jws class that also implements the Web service interface and javax.xml.rpc.server.ServiceLifecycle and calls the implementation class.

Then we copy these classes into the axis Web application. We start Tomcat to get the wsdls corresponding to each class and we use the wsdls to generate the client stubs.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts for the generation of client stubs. The scripts are defined in $PBHOME/axisMini2.

The table below lists the Web service interfaces of PageBoxLib, Repository and Pandora and the generation scripts for the generation of client stubs. The scripts are defined in \linux\axisMini2.

The tables below list the generation scripts and configuration files. The scripts and the generated archives are defined in $PBHOME/gen for JWSDP 1.3 and in $PBHOME/genjwsdp-1.5 for JWSDP 1.5. We describe the JWSDP 1.3 version. The only difference in the JWSDP 1.5 version is that the JWSDP is installed in $PRODUCTDIR/jwsdp-1.5 and the application server in $PRODUCTDIR/tomcat50-jwsdp instead of both the JWSDP and its application server in $PRODUCTDIR/jwsdp-1.3.

A build.sh script calls pageboxLib.sh, pagebox.sh and repository.sh.

A pageboxlib.sh scripts gets sources from $PBHOME/java/PageBoxLib, calls all the scripts and copies the archive in $PRODUCTDIR/jwsdp-1.3/shared/lib.

PBlibjar.sh generates stubs with $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wscompile.sh that generates Deploy.wsdl and model-deploy.xml.gz. We also need to run $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wsdeploy.sh. We populate a pageboxLibPortable Web application with compiled classes and in WEB-INF:

• The PageBox web.xml without information related to JWSDP

• The generated Deploy.wsdl and model-deploy.xml.gz

• A jaxrpc-ri.xml configuration file

pageboxLibPortable.sh copies the compiled classes into pageboxLibPortable, archives the pageboxLibPortable directory into pageboxlibPortable.war, calls wsdeploy.sh to generate a pageboxlibPorted.war archive and inflates pageboxlibPorted.war into a pageboxlibPorted directory.

In WEB-INF wsdeploy:

• Rewrite Deploy.wsdl and model-deploy.xml.gz

• Save a copy of the original web.xml in web-before.xml

• Save a copy of the original jaxrpc-ri.xml in jaxrpc-ri-before.xml

• Creates a usable web.xml

• Creates jaxrpc-ri-runtime.xml

Note:

• pagebox.war is generated from the PageBoxBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice and an example of rules.xml and of web.xml. You must setup the Web application in the same way for testing.

• A pagebox.sh script gets the sources from $PBHOME /java/PageBox and calls all the scripts.

Note:

• repository.war is generated from the RepositoryBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice, a javascript file, JSPs and an example of web.xml. You must setup the Web application in the same way for testing.

• A repository.sh script gets the sources from $PBHOME /java/Repository and calls all the scripts.

repwar.sh generates stubs with $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wscompile.sh that generates RepoQuery.wsdl and model-deploy.xml.gz. We also need to run $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wsdeploy.sh. We populate a repositoryPortable Web application with compiled classes and in WEB-INF:

• The Repository web.xml without information related to JWSDP

• The generated RepoQuery.wsdl and model-repoquery.xml.gz

• A jaxrpc-ri.xml configuration file

repositoryPortable.sh copies the compiled classes into repositoryPortable, archives the repositoryPortable directory into repositoryPortable.war, calls wsdeploy.sh to generate a repositoryPorted.war archive and inflates repositoryPorted.war into a repositoryPorted directory.

In WEB-INF wsdeploy:

• Rewrite RepoQuery.wsdl and model-deploy.xml.gz

• Save a copy of the original web.xml in web-before.xml

• Save a copy of the original jaxrpc-ri.xml in jaxrpc-ri-before.xml

• Creates a usable web.xml

• Creates jaxrpc-ri-runtime.xml

The tables below list the generation scripts and configuration files. The scripts and the generated archives are defined in \linux\gen for JWSDP 1.3 and in \linux\genjwsdp-1.5 for JWSDP 1.5. We describe the JWSDP 1.3 version. The only difference in the JWSDP 1.5 version is that the JWSDP is installed in \jwsdp-1.5 and the application server in \tomcat50-jwsdp instead of both the JWSDP and its application server in \jwsdp-1.3.

A build.bat script calls pageboxLib.bat, pagebox.bat and repository.bat.

A pageboxlib.bat script gets sources from \linux\java\PageBoxLib and calls all the scripts.

PBlibjar.bat generates stubs with \jwsdp-1.3\jaxrpc\bin\wscompile.bat that generates Deploy.wsdl and model-deploy.xml.gz. We also need to run \jwsdp-1.3\jaxrpc\bin\wsdeploy.bat. We populate a pageboxLibPortable Web application with compiled classes and in WEB-INF:

• The PageBox web.xml without information related to JWSDP

• The generated Deploy.wsdl and model-deploy.xml.gz

• A jaxrpc-ri.xml configuration file

pageboxLibPortable.bat copies the compiled classes into pageboxLibPortable, archives the pageboxLibPortable directory into pageboxlibPortable.war, calls wsdeploy.bat to generate a pageboxlibPorted.war archive and inflates pageboxlibPorted.war into a pageboxlibPorted directory.

In WEB-INF wsdeploy:

• Rewrite Deploy.wsdl and model-deploy.xml.gz

• Save a copy of the original web.xml in web-before.xml

• Save a copy of the original jaxrpc-ri.xml in jaxrpc-ri-before.xml

• Creates a usable web.xml

• Creates jaxrpc-ri-runtime.xml

Note:

• pagebox.war is generated from the PageBoxBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice and an example of rules.xml and of web.xml. You must setup the Web application in the same way for testing.

• A pagebox.bat script gets the sources from \linux\java\PageBox and calls all the scripts.

Note:

• repository.war is generated from the RepositoryBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice, a javascript file, JSPs and an example of web.xml. You must setup the Web application in the same way for testing.

• A repository.bat script gets the sources from \linux\java\Repository and calls all the scripts.

repwar.bat generates stubs with \jwsdp-1.3\jaxrpc\bin\wscompile.bat that generates RepoQuery.wsdl and model-deploy.xml.gz. We also need to run \jwsdp-1.3\jaxrpc\jaxrpc\bin\wsdeploy.bat. We populate a repositoryPortable Web application with compiled classes and in WEB-INF:

• The Repository web.xml without information related to JWSDP

• The generated RepoQuery.wsdl and model-repoquery.xml.gz

• A jaxrpc-ri.xml configuration file

repositoryPortable.bat copies the compiled classes into repositoryPortable, archives the repositoryPortable directory into repositoryPortable.war, calls wsdeploy.bat to generate a repositoryPorted.war archive and inflates repositoryPorted.war into a repositoryPorted directory.

In WEB-INF wsdeploy:

• Rewrite RepoQuery.wsdl and model-deploy.xml.gz

• Save a copy of the original web.xml in web-before.xml

• Save a copy of the original jaxrpc-ri.xml in jaxrpc-ri-before.xml

• Creates a usable web.xml

• Creates jaxrpc-ri-runtime.xml

The scripts and the generated archives are defined in $PBHOME/tomcatGen2 for Tomcat 4 and in $PBHOME/tomcatGen for Tomcat 5. We describe the Tomcat 4 version. The only difference in the Tomcat 5 version is that Tomcat is installed in $PRODUCTDIR/jakarta-tomcat-5.0.28 instead of $PRODUCTDIR/jakarta-tomcat-4.1.31.

A prepare.sh script copies sources from the JWSDP version ($PBHOME/java) and from the axisMini2 directory ($PBHOME/axisMini2/pageboxClt and $PBHOME/axisMini2/repositoryClt) into

• $PBHOME/tomcatGen2/PageBoxProj

• $PBHOME/tomcatGen2/PageBoxLibProj

• $PBHOME/tomcatGen2/RepositoryProj

Then you can use the IDE to display the code and fix compilation errors.

A prepare2.sh script copies the sources files from

• $PBHOME/tomcatGen2/PageBoxProj

• $PBHOME/tomcatGen2/PageBoxLibProj

• $PBHOME/tomcatGen2/RepositoryProj

into the source directories for ant processing:

• $PBHOME/tomcatGen2/PageBox

• $PBHOME/tomcatGen2/PageBoxLib

• $PBHOME/tomcatGen2/Repository

A prepare3.sh script copies the XSL, JSP, CSS, images and script files part of the deliveries into the binary delivery directories, $PBHOME/tomcatGen2/PageBoxBuild and $PBHOME/tomcatGen2/RepositoryBuild and into the test directories, $PRODUCTDIR/jakarta-tomcat-4.1.31/webapps/PageBox and $PRODUCTDIR/jakarta-tomcat-4.1.31/webapps/Repository.

A build.sh script calls pageboxLib.sh, pagebox.sh and repository.sh.

A pageboxlib.sh script gets calls all the scripts and copies the archive in $PRODUCTDIR/jakarta-tomcat-4.1.31/shared/lib.

Note:

• pagebox.war is generated from the PageBoxBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice and an example of rules.xml and of web.xml. You must setup the Web application in the same way for testing.

• A pagebox.sh script calls all the scripts.

Note:

• repository.war is generated from the RepositoryBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice, a javascript file, JSPs and an example of web.xml. You must setup the Web application in the same way for testing.

• A repository.sh script calls all the scripts.

The scripts and the generated archives are defined in \linux\tomcatGen2 for Tomcat 4 and in \linux\tomcatGen for Tomcat 5. We describe the Tomcat 4 version. The only difference in the Tomcat 5 version is that Tomcat is installed in \jakarta-tomcat-5.0.28 instead of \jakarta-tomcat-4.1.31.

A prepare.bat script copies sources from the JWSDP version (\linux\java) and from the axisMini2 directory (\linux\axisMini2\pageboxClt and \linux\axisMini2\repositoryClt) into

• \linux\tomcatGen2\PageBoxProj

• \linux\tomcatGen2\PageBoxLibProj

• \linux\tomcatGen2\RepositoryProj

Then you can use the IDE to display the code and fix compilation errors.

A prepare2.bat script copies the sources files from

• \linux\tomcatGen2\PageBoxProj

• \linux\tomcatGen2\PageBoxLibProj

• \linux\tomcatGen2\RepositoryProj

into the source directories for ant processing:

• \linux\tomcatGen2\PageBox

• \linux\tomcatGen2\PageBoxLib

• \linux\tomcatGen2\Repository.

A prepare3.sh script copies the XSL, JSP, CSS, images and script files part of the deliveries into the binary delivery directories, \linux\tomcatGen2\PageBoxBuild and \linux\tomcatGen2\RepositoryBuild and into the test directories, \jakarta-tomcat-4.1.31\webapps\PageBox and \jakarta-tomcat-4.1.31\webapps\Repository.

A build.bat script calls pageboxLib.bat, pagebox.bat and repository.bat.

A pageboxlib.bat script calls all the scripts.

Note:

• pagebox.war is generated from the PageBoxBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice and an example of rules.xml and of web.xml. You must setup the Web application in the same way for testing.

• A pagebox.bat script calls all the scripts.

Note:

• repository.war is generated from the RepositoryBuild directory that includes XSL and CSS stylesheets, the PageBox logo and license notice, a javascript file, JSPs and an example of web.xml. You must setup the Web application in the same way for testing.

• A repository.bat script calls all the scripts.

Pandora sources must be dispatched to three Web archives:

• distributed.war: the distributed application

• central.war: a central application to which distributed applications send commands

• paydeliver.war: a mockup that simulates a payment or a delivery facility and that is called by central.war

Therefore the generation process consists of dispatching sources and building the Web archives.

The scripts and the generated archives are defined in $PBHOME/pandoraGen.

The dispatch script is called dispatch.sh.

The table below lists the generation scripts and configuration files.

paydeliver.sh generates stubs with $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wscompile.sh that generates Query.wsdl and model-deploy.xml.gz and then paydeliverPortable.war. central.sh generates stubs with $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wscompile.sh that generates Update.wsdl and model-deploy.xml.gz and then centralPortable.war.

Then run pandoraPortable.sh to call $PRODUCTDIR/jwsdp-1.3/jaxrpc/bin/wsdeploy.sh and generate the paydeliver.war and central.war Web archives.

The scripts and the generated archives are defined in \linux\pandoraGen.

The dispatch script is called dispatch.bat.

The table below lists the generation scripts and configuration files.

paydeliver.bat generates stubs with \linux\jwsdp-1.3\jaxrpc\bin\wscompile.bat that generates Query.wsdl and model-deploy.xml.gz and then paydeliverPortable.war. central.sh generates stubs with \linux\jwsdp-1.3\jaxrpc\bin\wscompile.bat that generates Update.wsdl and model-deploy.xml.gz and then centralPortable.war.

Then run pandoraPortable.bat to call \linux\jwsdp-1.3\jaxrpc\bin\wsdeploy.bat and generate the paydeliver.war and central.war Web archives.

Pandora sources must be dispatched to three Web archives:

• distributed.war: the distributed application

• central.war: a central application to which distributed applications send commands

• paydeliver.war: a mockup that simulates a payment or a delivery facility and that is called by central.war

Therefore the generation process consists of dispatching sources and building the Web archives.

The scripts and the generated archives are defined in $PBHOME/pandoraTomcatGen2.

A prepare.sh script copies the source files from $PBHOME/pandora, $PBHOME/axisMini2/distributed and $PBHOME/axisMini2/central into $PBHOME/pandoraTomcatGen2/java. Then you can use the IDE to display the code and fix compilation errors. Then you dispatch the sources to $PBHOME/pandoraTomcatGen2/paydeliver, $PBHOME/pandoraTomcatGen2/central and $PBHOME/pandoraTomcatGen2/distributed with dispatch.sh.

The tables below lists the generation scripts and configuration files.

A prepare.bat script copies the source files from \linux\pandora, \linux\axisMini2\distributed and \linux\axisMini2\central into \linux\pandoraTomcatGen2\java. Then you can use the IDE to display the code and fix compilation errors. Then you dispatch the sources to \linux\pandoraTomcatGen2\paydeliver, \linux\pandoraTomcatGen2\central and \linux\pandoraTomcatGen2\distributed with dispatch.bat.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in $PBHOME/epimetheusGen.

A script called dispatch.sh gets the sources from $PBHOME/epimetheus.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in \linux\epimetheusGen.

A script called dispatch.bat gets the sources from \linux\epimetheus.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in $PBHOME/euroLCCgen.

A script called dispatch.sh gets the sources from $PBHOME/euroLCC.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in \linux\euroLCCgen.

A script called dispatch.bat gets the sources from \linux\euroLCC.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in $PBHOME/prometheusGen.

A script called dispatch.sh gets the sources from $PBHOME/prometheus.

The table below lists the generation scripts and configuration files.

The scripts and the generated archives are defined in \linux\prometheusGen.

A script called dispatch.bat gets the sources from \linux\prometheus.

The table below lists the generation scripts and configuration files.

Contact:support@pagebox.net
©2002-2004 Alexis Grandemange. Last modified .