Transcription

1 Setting up Servlet Support 8/15/02, rev 01/28/03, rev 12/05/03, rev 5/17/06, rev. 1/23/09 Table of Contents: A. Introduction B. Getting Java C. Sun's servletrunner D. ServletExec E. Apache 1.3 and Jserv F. Apache and Tomcat G. Apache 2.2 and Tomcat 6.0 on Windows H. Multiple initargs and CyberHTML A. Introduction Servlets allow CGI style interaction with dynamic web s without a process invocation for each exchange. CyberTools provides two Servlets: 1. CyberHTML, which supports the CyberTools HTML OPAC and other HTML applications; 2. TunnelServlet, which provides HTTP tunneling so that a CyberJ (CyberTools for Java) client can access the server from behind a firewall or proxy server. Servlets require a Java Virtual Machine to be installed on your server system. One way to run servlets is with the servletrunner program that comes with the Java Servlet Development Kit that you can download from Sun. This program has to run on a different port from 80, if you have a web server running on port 80 (the usual world wide web port). Using a port other than 80 can introduce firewall and/or proxy server problems in that firewalls and proxy servers often block ports other than 80. Certain web servers support the use of servlets directly (any from Sun, IBM, JigSaw, and Tomcat from Apache). The standard Apache web server does not support servlets, without an add-on called Apache Jserv. The Microsoft web servers do not support servlets but there are commercially available ISAPI add-on products that will make them do so. Two of them are Allaire's jrun and New Atlanta's ServletExec. New Atlanta also provides a NSAPI add-on for older Netscape web servers. Of these products we have only tried ServletExec and Apache Jserv. CyberTools "tools" customers do not need to install the CyberHTML servlet, and should only install the TunnelServlet if their application will be run by users behind complex firewalls and/or proxy servers. CyberTools for Libraries sites need to install the CyberHTML servlet. If a library's users have a complex firewall and/or proxy server blocking the browser from running CyberTools for Libraries, then the TunnelServlet needs to be installed on the server.

2 B. Getting Java If your server runs Window XP, 2000, NT, 9x, Linux, or Solaris you can get the Java Runtime Environment (JRE) from Sun, also known as the Java Plug-in. You can download this from If you have other platforms, you can probably get Java from your platform vendor. If that vendor is IBM, they provide Java for all their platforms. C. Sun's servletrunner You can find a link for the JSDK at If you download and install the JSDK then you will have the servletrunner. By default servletrunner looks in its examples subdirectory for servlet classes and the servlet.properties file. So to run the OPAC Servlet in the default way you would: 1. copy CyberHTML*.class and TunnelServlet*.class to the examples subdirectory 2. edit servlet properties in that directory. You should add the line: servlet.cyberhtml.code=cyberhtml and for the TunnelServlet: servlet.tunnel.code=tunnelservlet 3. If you then run servletrunner in the bin subdirectory, you should be able to access the CyberHTML servlet as: where appname is the name of the application, e.g., HTMLOPAC, thus: The path for the tunnel servlet would be This path would be used as the value of the applet "Tunnel" parameter. See also cyberj_bootstrap.html. 4. If your M/Caché database is on a different node from the web server node, add the line: servlet.cyberhtml.initargs=mnode=<node name or IP address> 2

3 D. ServletExec You can download ServletExec (for ISAPI) from It includes a PDF installation manual and a PDF user manual. You can run the free unregistered version to support up to 3 simultaneous connections, which should be plenty for CyberTools for Libraries sites for the HTML OPAC only. Unfortunately, the free version is not password protected, thus, is not secure. If you are using the TunnelServlet, you will need a connection for every simultaneous user connecting via the tunnel for reliable operation. If you are using CyberHTML, you will need a connection for every 5 to 10 users (therefore the 3 free connections should support 15 to 30 users, depending on server speed). The version of ServletExec that you pay for sets no limit on the number of simultaneous connections (although the operating system or Web server may). For CyberTools for Libraries users, Back Office users that have a closed firewall or a closed proxy server between them and the library server will need the TunnelServlet, and a connection for each of those users. The HTML OPAC does not tunnel, but needs a connection for every 5 to 10 HTML OPAC users. Therefore, to calculate the number of connections, use these examples: a. The library's Back Office users have a direct connection to the library server, thus, the TunnelServlet does not need to be installed, nor will connections need to be allocated to it. The library anticipates 15 OPAC users, thus, 1 to 3 servlet connections. The 3 free connections will work, and no additional connections are needed. b. Five (5) Back Office users behind a closed firewall or proxy, and 15 OPAC users will need 6 to 8 simultaneous connections, thus, you will need to procure a license for these connections. Before installing ServletExec, you must install the Sun JRE 1.2 (or greater), available from Follow the installation instructions carefully. Once you get the Sun test servlet running you can: 1. copy CyberHTML*.class and TunnelServlet*.class to the New Altanta servlets subdirectory, by default: <bootdrive>:\program Files\New Atlanta\ServletExec ISAPI\servlet 2. Run the ServletExec Admin Tool to create an alias such as /cytools/cyberhtml for CyberHTML and /cytools/tunnel for TunnelServlet. Do not include the ".class" suffix when you name the class. 3

4 3. While still in the Admin Tool, Configure Servlet (in ServletExec version 3.x) or Manage Servlet (in ServletExec version 4) and then Add Servlet, supplying the name and class name both as CyberHTML. If you need to tunnel, and the web server and DBMS are on different computers, then you must add "TunnelServlet" too. This will allow you to add servlet initialization parameters as name and value pairs into the form. a. If you are not using the CyberHTML servlet, then proceed to Step 3b. Add the name "MaxConnections" and a number as the value. The number you add will determine the maximum number of M server processes (and therefore M license slots) that the CyberHTML servlet will use. This parameter allows you to tradeoff response time versus M license slots. If you are using the free version of ServletExec, there is no reason to enter a number greater than 3. A value of 3 should normally suffice for 15 or 30 end users, while employing 3 M/Caché processes total as needed, i.e., if no one is accessing the application via the servlet, then there are no M/Caché processes in use either. b. If your M database is on a different node from the web server node then Edit Servlet. Add the name "mnode" and for the value, the node name or IP address of the M server. 4. You should be able to access the CyberHTML servlet as: where appname is the name of the application, e.g., HTMLOPAC, thus: The path for the tunnel servlet would be ServletExec on Microsoft Windows 2003 Server For ServletExec to run on Microsoft Windows 2003 Server, you must install ServletExec/ISAPI 5.0 for Microsoft IIS. It is found at Install it similarly to the above instructions, but there are no further setup steps to do beyond copying the CyberTools servlets to the New Atlanta servlet directory ( typically <bootdrive>:\program Files\New Atlanta\ServletExec ISAPI\servlet), and then invoking the servlets ( 4

5 E. Apache 1.3 and Jserv We have only tried the rpm version for Linux (on Red Hat 6.2), and the Apache 1.3 and Jserv for Windows NT, 2K, & XP. A customer has gotten the CyberTools servlets to work with Apache Jserv on Sun Solaris. Follow the instructions under a for a Linux install, or b for a Windows install. After completing these steps you need to restart your web server. Linux Install: You can download Jserv from The rpm will be something like: ApacheJserv i386.rpm. The Web site has ample installation and set up instructions for other versions. To install that version, you merely: rpm -i ApacheJserv i386.rpm The installation will place 3 configuration files in /etc/httpd/conf/jserv. To set up the servlet place CyberHTML*.class and TunnelServlet*.class in some directory. e.g. "/home/cytools" and come up with a virtual path that is not in use, e.g. "/cytools" and a zone that is not in use, e.g. "cytools". 1. Edit jserv.conf to map the directory; add the line: ApJservMount /cytools /cytools This is schematically ApJservMount /<virtual path> /<zone>. 2. Edit jserv.properties wrapper.bin={java runtime executable, e.g. /usr/java/jre1.3.1/bin/java) zones = root,cytools cytools.properties = /etc/httpd/conf/jserv/cytools.properties 3. Copy zone.properties to cytools.properties and edit that: repositories=/home/cytools And in the Servlet Aliases section: servlet.cyberhtml.code=cyberhtml servlet.tunnel.code=tunnelservlet Now continue with step 4 under All Platforms. 5

6 Windows Install: You will find the file ApacheJServ exe at java.apache.org. Download and install Apache JServ with this executable. You will need to edit 2 configuration files placed in the C:\Program Files\Apache JServ 1.1.2\conf directory. Those files are jserv.conf, and jserv.properties 1. Edit jserv.conf to map the directory; add the line: ApJservMount /cytools /cytools This is schematically ApJservMount /<virtual path> /<zone>. 2. Edit jserv.properties wrapper.bin={java runtime executable, e.g. c:\windows\system32\java.exe} zones = root,cytools cytools.properties = C:\Program Files\Apache JServ 1.1.2\servlets\cytools.properties You will now need to go to the C:\Program Files\Apache JServ 1.1.2\servlets directory you specified in step 2. In that directory perform the following procedure: 3. Copy zone.properties to cytools.properties and edit that: repositories=c:\program Files\CyberTools\CyberTools\CyberJ\servlets And in the Servlet Aliases section: servlet.cyberhtml.code=cyberhtml servlet.tunnel.code=tunnelservlet All platforms: 4. If your M/Caché database is on a different node from the web server node, add the line: servlet.cyberhtml.initargs=mnode=<node name or IP address> 5. If you then restart the http daemon, you should be able to access the CyberHTML servlet as: and the path for the Tunnel Servlet would be: which would be used for the CyberJ Applet parameter. 6

7 F. Apache and Tomcat We are currently using Apache version , and Tomcat version Apache should be installed with Linux (RedHat). Both are available at The latest version of Apache (2.2.x) can be used as a direct substitution in the instructions that follow. In RedHat s latest Enterprise release (RHEL5), Tomcat5 can be automatically installed as part of the operating system install. The automatic startup is taken care of in this process, and the main directory tree where Tomcat5 is located is /var/lib/tomcat5. Again, this directory can be substituted for /usr/local/tomcat5 used in the instructions below. For tomcat the file is apache-tomcat tar.gz. Untar this file, to a temporary location, and then copy over everything below the apache-tomcat directory to /usr/local/tomcat5. 1. Automatic Tomcat Startup To allow Tomcat to start up automatically you will need to copy /usr/local/tomcat5/bin/startup.sh to /etc/init.d/tomcat5, and edit it in the following fashion: Add these two lines after the shell declaration at the top of the file: chkconfig: description: Tomcat is te Apache Servlet Engine RI for Servlet 2.4/JSP1.2 These lines enable tomcat5 to be controlled with chkconfig, and thus allow it to start at bootup. Add these two lines so that Tomcat knows where java is: JAVA_HOME="/usr/bin/javadir" export JAVA_HOME Comment out all of these lines like this: if $os400; then -x will Only work on the os400 if the files are: 1. owned by the user 2. owned by the PRIMARY group of the user this will not work if the user belongs in secondary groups eval else if [! -x "$PRGDIR"/"$EXECUTABLE" ]; then echo "Cannot find $PRGDIR/$EXECUTABLE" echo "This file is needed to run this program" exit 1 fi fi 7

8 Then near the bottom, change the Tomcat invoking line like this: exec "$PRGDIR"/"$EXECUTABLE" start exec /usr/local/tomcat5/bin/catalina.sh start Now type the following command to add the Tomcat startup script to the Linux startup procedure: chkconfig --add tomcat5 To verify that Tomcat will start up upon booting the server type the following, and verify the output: chkconfig --list tomcat5 tomcat5 0:off 1:off 2:off 3:on 4:on 5:on 6:off 2. Tomcat Configuration and Apache Connector In the /usr/local/tomcat5/conf directory, you will need to make some changes. In the /usr/local/tomcat5/conf directory, edit the logging.properties file, changing the logging directory from ${catalina.base}/logs to /var/log/tomcat5. Make sure to create this directory. In the /usr/local/tomcat5/conf directory, create a new directory jk, and then change directory into it: mkdir jk cd jk You will need to create two files in this directory. The first file is called mod_jk.conf. Use vi to create it: vi mod_jk.conf When you are brought into the vi editor just hit the lower-case a key, and then copy and paste the following contents into it: <IfModule mod_jk.c> JkWorkersFile /usr/local/tomcat5/conf/jk/workers.properties JkLogFile logs/jk.log JkLogLevel error JkMount /*.jsp ajp13 JkMount /servlet/* ajp13 JkMount /examples/* ajp13 JkMount /cgi-bin/* ajp13 </IfModule> After pasting the above into the new file, hit the escape-key, and then hit the upper-case Z key twice. This will write and save the new file. 8

9 The second file is called workers.properties. Use vi as above, copying, pasting, and saving the following into it: workers.properties - This file provides jk derived plugins with the needed information to connect to the different tomcat workers. Note that the distributed version of this file requires modification before it is usable by a plugin. As a general note, the characters $( and ) are used internally to define macros. Do not use them in your own configuration!!! Whenever you see a set of lines such as: x=value y=$(x)\something the final value for y will be value\something Normaly all you will need to do is un-comment and modify the first three properties, i.e. workers.tomcat_home, workers.java_home and ps. Most of the configuration is derived from these. When you are done updating workers.tomcat_home, workers.java_home and ps you should have 3 workers configured: - An ajp12 worker that connects to localhost: An ajp13 worker that connects to localhost: A jni inprocess worker. - A load balancer worker However by default the plugins will only use the ajp12 worker. To have the plugins use other workers you should modify the worker.list property. OPTIONS ( very important for jni mode ) workers.tomcat_home should point to the location where you installed tomcat. This is where you have your conf, webapps and lib directories. workers.tomcat_home=c:\tomcat workers.tomcat_home=/usr/local/tomcat5 workers.java_home should point to your Java installation. Normally you should have a bin and lib directories beneath it. workers.java_home=/usr/bin/javadir You should configure your environment slash... ps=\ on NT and / on UNIX and maybe something different elsewhere. ps=\ ps=/ 9

10 ADVANCED MODE DEFAULT worket list The workers that your plugins should create and work with Add 'inprocess' if you want JNI connector worker.list=ajp12, ajp13, inprocess DEFAULT ajp12 WORKER DEFINITION Defining a worker named ajp12 and of type ajp12 Note that the name and the type do not have to match. worker.ajp12.port=8007 worker.ajp12.host=localhost worker.ajp12.type=ajp12 Specifies the load balance factor when used with a load balancing worker. Note: ----> lbfactor must be > > Low lbfactor means less work done by the worker. worker.ajp12.lbfactor= DEFAULT ajp13 WORKER DEFINITION Defining a worker named ajp13 and of type ajp13 Note that the name and the type do not have to match. worker.ajp13.port=8009 worker.ajp13.host=localhost worker.ajp13.type=ajp13 Specifies the load balance factor when used with a load balancing worker. Note: ----> lbfactor must be > > Low lbfactor means less work done by the worker. worker.ajp13.lbfactor=1 Specify the size of the open connection cache. worker.ajp13.cachesize 10

11 DEFAULT LOAD BALANCER WORKER DEFINITION The loadbalancer (type lb) workers perform wighted round-robin load balancing with sticky sessions. Note: ----> If a worker dies, the load balancer will check its state once in a while. Until then all work is redirected to peer workers. worker.loadbalancer.type=lb worker.loadbalancer.balanced_workers=ajp12, ajp DEFAULT JNI WORKER DEFINITION Defining a worker named inprocess and of type jni Note that the name and the type do not have to match. worker.inprocess.type=jni CLASSPATH DEFINITION Additional class path components. worker.inprocess.class_path=$(workers.tomcat_home)$(ps)lib$(ps)tomcat.jar Setting the command line for tomcat. Note: The cmd_line string may not contain spaces. worker.inprocess.cmd_line=start Not needed, but can be customized. worker.inprocess.cmd_line=-config worker.inprocess.cmd_line=$(workers.tomcat_home)$(ps)conf$(ps)server.xml worker.inprocess.cmd_line=-home worker.inprocess.cmd_line=$(workers.tomcat_home) The JVM that we are about to use This is for Java2 Windows worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)bin$(ps)classic$(ps)jvm.dll IBM JDK1.3 worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)bin$(ps)classic$(ps)libjvm.so Unix - Sun VM or blackdown worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)lib$(ps)i386$(ps)classic$(ps)li bjvm.so And this is for jdk1.1.x worker.inprocess.jvm_lib=$(workers.java_home)$(ps)bin$(ps)javai.dll 11

12 Setting the place for the stdout and stderr of tomcat worker.inprocess.stdout=$(workers.tomcat_home)$(ps)logs$(ps)inprocess.stdout worker.inprocess.stderr=$(workers.tomcat_home)$(ps)logs$(ps)inprocess.stderr Setting the tomcat.home Java property worker.inprocess.sysprops=tomcat.home=$(workers.tomcat_home) Java system properties worker.inprocess.sysprops=java.compiler=none worker.inprocess.sysprops=myprop=mypropvalue Additional path components. worker.inprocess.ld_path=d:$(ps)sqllib$(ps)bin mod_jk.conf, and workers.properties are important files for the link between Apache and Tomcat. Important lines in workers.properties are: workers.tomcat_home=/usr/local/tomcat5 workers.java_home=/usr/bin/javadir ps=/ Make sure these reflect your server s specifications. For Apache, there are also a few changes that need to be made. The configuration file for Apache should be found at /etc/httpd/conf/httpd.conf. Change Timeout to 300, and KeepAlive to On. Add the line at the bottom of the section where other similar lines exist: LoadModule jk_module modules/mod_jk.so You need to me sure to add the mod_jk.so file to the modules directory, which is found at /usr/lib/httpd/modules or /etc/httpd/modules. It can also be found at the Apache web site: After downloading the appropriate so file, rename it to mod_jk.so. If not using the standard DocumentRoot setting, change DocumentRoot to /home/httpd/html/cybertoolsforlibraries, and change the line that starts with <Directory, to reference /home/httpd/html. Comment out the references to the /var/www/cgi-bin directory. You can also just set up your webserver directories under the default DocumentRoot if it is preferred. Finally, at the bottom, and the line: Include "/usr/local/tomcat5/conf/jk/mod_jk.conf" 12

13 3. CyberTools Servlets Create a cgi-bin directory under the /usr/local/tomcat5/webapps directory tree. Under cgi-bin you will need a WEB-INF directory, and under that a classes directory. Copy to /usr/local/tomcat5/webapps/cgi-bin/web-inf/classes the CyberTools servlet classes: CyberHTML$BlockingQueue.class CyberHTML.class CyberHTML$OneConnection.class CyberHTML$TimeoutChecker.class OPACServlet$BlockingQueue.class OPACServlet.class OPACServlet$OneConnection.class OPACServlet$TimeoutChecker.class TunnelServlet.class TunnelServlet$OneConnection.class Edited /usr/local/tomcat5/webapps/cgi-bin/web-inf/web.xml to contain: <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" " <web-app> <display-name>cybertools Servlets</display-name> <description> CyberHTML, TunnelServlet. </description> <servlet> <servlet-name> CyberHTML </servlet-name> <servlet-class> CyberHTML </servlet-class> <!-- <init-param> <param-name>foo</param-name> <param-value>bar</param-value> </init-param> --> 13

14 </servlet> <servlet> <servlet-name> TunnelServlet </servlet-name> <servlet-class> TunnelServlet </servlet-class> </servlet> <servlet-mapping> <servlet-name> CyberHTML </servlet-name> <url-pattern> /CyberHTML </url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name> TunnelServlet </servlet-name> <url-pattern> /tunnel </url-pattern> </servlet-mapping> </web-app> Windows Install: The Windows install process for Apache and Tomcat is a little less complicated than the Unix process, and allow for the latest stable releases of each. To install Apache, download the latest version (2.2.4) using the MSI installer package Windows will automatically install Apache when you run this file. Edit the httpd.conf file as described in the Unix install. The Include line should have the correct windows-oriented path. To install Tomcat, download the latest Tomcat5 release. You can find the windows service installer file here: 5/v5.5.23/bin/apache-tomcat exe. This is referred to as the Core distribution. Install the web.xml file as described for the Unix install. The appropriate windows directory would be similar to C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps\cgibin\WEB-INF. Also, setup the mod_jk.conf and workers.properties in the C:\Program Files\Apache Software Foundation\Tomcat 5.5\conf\jk directory. Change the JkWorkersFile line in mod_jk.conf, and change the same lines mentioned in the Unix install for the workers.properties file, the ps line should equal \ instead of /. 14

15 G. Apache 2.2 and Tomcat 6.0 on Windows Summary of Steps: 1. Install Apache in directory: C:\Program Files\Apache Software Foundation\Apache Install Tomcat in directory: C:\Program Files\Apache Software Foundation\Tomcat Create new directories under C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps 3.1 cgi-bin under webapps 3.2 WEB-INF under cgi-gin 3.3 classes under WEB-INF thus: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB- INF\classes 4. Create new file mod_jk.conf in directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\jk 5. Create new file workers.properties in directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\jk 6. Create new file web.inf in directory C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB-INF 7. Download connector mod_jk.so from to directory C:\Program Files\Apache Software Foundation\Apache2.2\modules\ 8. Copy CyberTools servlets class to directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB- INF\classes 9. Edit file httpd.conf in directory: C:\Program Files\Apache Software Foundation\Apache2.2\conf 10. If desired, make sure Apache and Tomcat are automatically started when Windows starts. Note: be sure to make of backups of any files that you are modifying. Below are details on each of the above Steps : 15

16 Step-1: Install Apache in directory: C:\Program Files\Apache Software Foundation\Apache2.2\ To install Apache, download the latest version (2.2.4) using the MSI installer package Windows will automatically install Apache when you run this file. Apache should be installed into directory: C:\Program Files\Apache Software Foundation\Apache2.2 If a later version of Apache is installed the directory, Apache 2.2 will be named for the later version as Apache x.x Step-2: Install Tomcat in directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\ To install Tomcat, download the latest Tomcat5 release. You can find the windows service installer file here: 5/v5.5.23/bin/apache-tomcat exe. This is referred to as the Core distribution. If a later version of Tomcat is installed the directory, Tom 6.0 will be named for the later version as Tomcat x.x Step-3: Create directories under: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps Create diretory cgi-bin under: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps Create directory WEB-INF under: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin Create directory classes under: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgibin\WEB-INF full directory structure after this will be: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB-INF\classes 16

17 Step-4: Create new file mod_jk.conf in directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\jk\ Create mod_jk.conf and copy the following line into it <IfModule mod_jk.c> JkWorkersFile "C:\Program Files\Apache Software Foundation\Tomcat6.0\conf\jk\workers.properties" JkLogFile logs/jk.log JkLogLevel error JkMount /*.jsp ajp13 JkMount /servlet/* ajp13 JkMount /examples/* ajp13 JkMount /cgi-bin/* ajp13 </IfModule> Note: if Tomcat is installed in a directory other than Tomcat 6.0 adjust line, JkWorkersFile "C:\Program Files\Apache Software Foundation\Tomcat6.0\conf\jk\workers.properties" with proper directory name. Step-5: Create new file workers.properties in directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\jk\ copy the following lines into the new file ( note files end with line end of workers.properties workers.properties - This file provides jk derived plugins with the needed information to connect to the different tomcat workers. Note that the distributed version of this file requires modification before it is usable by a plugin. As a general note, the characters $( and ) are used internally to define macros. Do not use them in your own configuration!!! Whenever you see a set of lines such as: x=value y=$(x)\something the final value for y will be value\something Normaly all you will need to do is un-comment and modify the first three properties, i.e. workers.tomcat_home, workers.java_home and ps. Most of the configuration is derived from these. When you are done updating workers.tomcat_home, workers.java_home and ps you should have 3 workers configured: - An ajp12 worker that connects to localhost: An ajp13 worker that connects to localhost: A jni inprocess worker. - A load balancer worker However by default the plugins will only use the ajp12 worker. To have the plugins use other workers you should modify the worker.list property. 17

18 OPTIONS ( very important for jni mode ) workers.tomcat_home should point to the location where you installed tomcat. This is where you have your conf, webapps and lib directories. workers.tomcat_home=c:\tomcat workers.tomcat_home="c:\program Files\Apache Software Foundation\Tomcat 6.0\conf\jk" workers.java_home should point to your Java installation. Normally you should have a bin and lib directories beneath it. workers.java_home="c:\program Files\Java\jre1.6.0_03" You should configure your environment slash... ps=\ on NT and / on UNIX and maybe something different elsewhere. ps=\ ADVANCED MODE DEFAULT worket list The workers that your plugins should create and work with Add 'inprocess' if you want JNI connector worker.list=ajp12, ajp13, inprocess DEFAULT ajp12 WORKER DEFINITION Defining a worker named ajp12 and of type ajp12 Note that the name and the type do not have to match. worker.ajp12.port=8007 worker.ajp12.host=localhost worker.ajp12.type=ajp12 Specifies the load balance factor when used with a load balancing worker. Note: ----> lbfactor must be > > Low lbfactor means less work done by the worker. worker.ajp12.lbfactor= DEFAULT ajp13 WORKER DEFINITION Defining a worker named ajp13 and of type ajp13 18

19 Note that the name and the type do not have to match. worker.ajp13.port=8009 worker.ajp13.host=localhost worker.ajp13.type=ajp13 Specifies the load balance factor when used with a load balancing worker. Note: ----> lbfactor must be > > Low lbfactor means less work done by the worker. worker.ajp13.lbfactor=1 Specify the size of the open connection cache. worker.ajp13.cachesize DEFAULT LOAD BALANCER WORKER DEFINITION The loadbalancer (type lb) workers perform wighted round-robin load balancing with sticky sessions. Note: ----> If a worker dies, the load balancer will check its state once in a while. Until then all work is redirected to peer workers. worker.loadbalancer.type=lb worker.loadbalancer.balanced_workers=ajp12, ajp DEFAULT JNI WORKER DEFINITION Defining a worker named inprocess and of type jni Note that the name and the type do not have to match. worker.inprocess.type=jni CLASSPATH DEFINITION Additional class path components. worker.inprocess.class_path=$(workers.tomcat_home)$(ps)lib$(ps)tomcat.jar Setting the command line for tomcat. Note: The cmd_line string may not contain spaces. worker.inprocess.cmd_line=start Not needed, but can be customized. worker.inprocess.cmd_line=-config worker.inprocess.cmd_line=$(workers.tomcat_home)$(ps)conf$(ps)server.xml worker.inprocess.cmd_line=-home worker.inprocess.cmd_line=$(workers.tomcat_home) The JVM that we are about to use 19

20 This is for Java2 Windows worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)bin$(ps)classic$(ps)jvm.dll IBM JDK1.3 worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)bin$(ps)classic$(ps)libjvm.so Unix - Sun VM or blackdown worker.inprocess.jvm_lib=$(workers.java_home)$(ps)jre$(ps)lib$(ps)i386$(ps)classic$(ps)li bjvm.so And this is for jdk1.1.x worker.inprocess.jvm_lib=$(workers.java_home)$(ps)bin$(ps)javai.dll Setting the place for the stdout and stderr of tomcat worker.inprocess.stdout=$(workers.tomcat_home)$(ps)logs$(ps)inprocess.stdout worker.inprocess.stderr=$(workers.tomcat_home)$(ps)logs$(ps)inprocess.stderr Setting the tomcat.home Java property worker.inprocess.sysprops=tomcat.home=$(workers.tomcat_home) Java system properties worker.inprocess.sysprops=java.compiler=none worker.inprocess.sysprops=myprop=mypropvalue Additional path components. worker.inprocess.ld_path=d:$(ps)sqllib$(ps)bin end of workers.properties Note the following 2 lines from workers.properties may need to be changed if directory name are change: workers.tomcat_home="c:\program Files\Apache Software Foundation\Tomcat 6.0\conf\jk" workers.java_home="c:\program Files\Java\jre1.6.0_03" 20

21 Step-6: Create new file web.inf in directory C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB-INF copy the following lines into the new file: <?xml version="1.0" encoding="iso "?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" " <web-app> <display-name>cybertools Servlets</display-name> <description> CyberHTML, TunnelServlet. </description> <servlet> <servlet-name> CyberHTML </servlet-name> <servlet-class> CyberHTML </servlet-class> </servlet> <servlet> <servlet-name> TunnelServlet </servlet-name> <servlet-class> TunnelServlet </servlet-class> </servlet> <servlet-mapping> <servlet-name> CyberHTML </servlet-name> <url-pattern> /CyberHTML </url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name> TunnelServlet </servlet-name> <url-pattern> /tunnel </url-pattern> </servlet-mapping> </web-app> 21

22 Step-7: Download connector mod_jk.so from to directory C:\Program Files\Apache Software Foundation\Apache2.2\modules\ Actual name of file may be different if a newer version of the connector exist. Step-8: Copy CyberTools servlets class to directory: C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\cgi-bin\WEB- INF\classes CyberHTML$BlockingQueue.class CyberHTML$OneConnection.class CyberHTML$TimeoutChecker.class CyberHTML.class OPACServlet$BlockingQueue.class OPACServlet$OneConnection.class OPACServlet$TimeoutChecker.class OPACServlet.class TunnelServlet$OneConnection.class TunnelServlet.class Step-9: Edit file httpd.conf in directory: C:\Program Files\Apache Software Foundation\Apache2.2\conf\ the following lines will need to be changed from the httpd.conf that is installed with Apache: 9.1 Add the following line in the LoadModule section. mod_jk-apache.so should reflect the name of the connect downloaded in step 7. In this example I downloaded mod_jk-apache so LoadModule jk_module modules/mod_jk-apache so 9.2 Modify DocumentRoot setting to reflect directory location of your Apache installation. DocumentRoot "C:/Program Files/Apache Software Foundation/Apache2.2/htdocs" 22

23 9.3 Add the following lines in the Alias section: Alias /cyberj/ "C:/program files/cybertools/cyberj/" <Directory "C:/program files/cybertools/cyberj"> Options Indexes FollowSymlinks MultiViews AllowOverride None Order allow,deny Allow from all </Directory> 9.4 Add the following 2 lines to the end of the file: for CyberTools' servlets Include "C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\jk\mod_jk.conf" Step-10: If desired, make sure Apache and Tomcat are automatically started when Windows starts. 23

24 H. Multiple initargs and CyberHTML All of the servlets have more than one initialization parameter. They all have mnode, as described above. They also have mport in the unlikely event that the CyberTools Application Server is not listening on the default port (20001). CyberHTML has a MaxConnections parameter that determines the maximum number of M/Caché connections (M/Caché license slots) the servlet will use at once. This defaults to one, but more than one will provide better runtime performance when there are many simultaneous client connections. ServletExec allows specification of multiple init parameters in a GUI table. In the case of apache jserv or servletrunner where it is specified in a text file, the parameters are a comma separated list. Thus if you are setting up apache jserv and you want to specify both mnode and MaxConnections you would have a line like: servlet.cyberhtml.initargs=mnode= ,maxconnections=2 24