hgomez 2002/09/05 01:38:50
Added: jk/xdocs/jk neshowto.xml aphowto.xml iishowto.xml
Log:
Reworked documents for Apache, IIS, NES
Revision Changes Path
1.1 jakarta-tomcat-connectors/jk/xdocs/jk/neshowto.xml
Index: neshowto.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1" ?>
<document>
<properties>
<title>Netscape/iPlanet HowTo</title>
<author email="[EMAIL PROTECTED]">Henri Gomez</author>
<author email="[EMAIL PROTECTED]">Gal Shachor</author>
</properties>
<section name="Introduction">
<p>
This document explains how to set up Netscape web servers to cooperate with Tomcat.
</p>
<p>
Normally the Netscape web servers come with their own Servlet engine,
but you can also configure them to send servlet and JSP requests to Tomcat
using the Tomcat redirector plugin.
</p>
<subsection name="Document Conventions and Assumptions">
<p>
${tomcat_home} is the root directory of tomcat.
Your Tomcat installation should have the following subdirectories:
<ul>
<li>
${tomcat_home}\conf - Where you can place various configuration files
</li>
<li>
${tomcat_home}\webapps - Containing example applications
</li>
<li>
${tomcat_home}\bin - Where you place web server plugins
</li>
</ul>
</p>
<p>
In all the examples in this document ${tomcat_home} will be <b>c:\jakarta-tomcat</b>.
A worker is defined to be a tomcat process that accepts work from the IIS server.
</p>
</subsection>
<subsection name="Supported Configuration">
<p>
The Netscape-Tomcat redirector was developed and tested on:
<ul>
<li>
WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs) and
some Unixes
</li>
<li>
Netscape Enterprise 3.0 and 3.61
</li>
<li>
Tomcat 3.2.x, 3.3.x, Tomcat 4.0.x, Tomcat 4.1.x and Tomcat 5
</li>
</ul>
</p>
<p>
The redirector uses <b>ajp12</b> and <b>ajp13</b> to send requests to the Tomcat
containers.
There is also an option to use Tomcat in process,
more about the in-process mode can be found in the in process howto.
</p>
</subsection>
<subsection name="Who support ajp protocols ?">
<p>
The ajp12 protocol is only available in Tomcat 3.2.x and 3.3.x.
</p>
<p>
The <b>ajp12</b> has been <b>deprecated</b> with Tomcat 3.3.x and you should use
instead
<b>ajp13</b> which is the only ajp protocol known by Tomcat 4.0.x, 4.1.x and 5.
</p>
<p>
Of course Tomcat 3.2.x and 3.3.x also support ajp13 protocol.
</p>
<p>
Others servlet engines such as <b>jetty</b> have support for ajp13 protocol
</p>
</subsection>
<subsection name="How does it work ?">
<p>
<ol>
<li>
The Netscape-Tomcat redirector is an Netscape service step plugin,
Netscape load the redirector plugin and calls its service handler
function for request that are assigned to the "servlet" configuration object.
</li>
<li>
For each in-coming request Netscape will execute the set of NameTrans directives
that we added to obj.conf, the assign-name function will check if it's from
parameter matches the request URL.
</li>
<li>
If a match is found, assign-name will assign the servlet object name to the request.
This will cause Netscape to send the request to the servlet configuration object.
</li>
<li>
Netscape will execute our jk_service extension. The extension collects the
request parameters and forwards them to the appropriate worker using the ajp13
protocol
(the worker="defworker" parameter in jk_service inform it that the worker for this
request is named <b>defworker</b>).
the workers properties files, <b>workers.properties</b>, will indicate that
defworker use ajp13 protocol.
</li>
<li>
The extension collects the response from the worker and returns it to the browser.
</li>
</ol>
</p>
</subsection>
</section>
<section name="Installation">
<p>
A pre-built version of the Netscape redirector, nsapi_redirect.dll, may be available
under
the win32/i386 directory of jakarta-tomcat-connectors distribution.
For those using Netscape as your browser, try downloading a zip version of the file,
if available.
There can be problems using Netscape to download DLL files.
You can also build a copy locally from the source present in
jakarta-tomcat-connectors distribution.
The Tomcat redirector requires two entities:
<ul>
<li>
nsapi_redirect.dll - The Netscape server plugin, either obtain a pre-built DLL or
build it yourself
(see the build section).
</li>
<li>
workers.properties - A file that describes the host(s) and port(s) used by the
workers (Tomcat processes).
A sample workers.properties can be found under the conf directory.
</li>
</ul>
The installation includes the following parts:
<ul>
<li>
Configuring the NSAPI redirector with a default /examples context and checking that
you can serve servlets
with Netscape.
</li>
<li>
Adding more contexts to the configuration.
</li>
</ul>
</p>
</section>
<section name="Configuring the NSAPI Redirector">
<p>
In this document we'll assume that nsapi_redirect.dll is placed in
<b>c:\jk\lib\nsapi_redirect.dll</b>, the properties file is in<b>c:\jk\conf</b>
and you created a log directory <b>c:\jk\logs</b>
</p>
<ul>
<li>
If the Netscape built in servlet support is working disable it.
</li>
<li>
Add the redirector plugin into the Netscape server configuration.
Edit your server <b>obj.conf</b> and add the following lines:
</li>
</ul>
<screen>
<note>In the Init section:</note>
<read>Init fn="load-modules" funcs="jk_init,jk_service"
shlib="c:/jk/lib/nsapi_redirect.dll"</read>
<read>Init fn="jk_init" worker_file="c:/jk/conf/workers.properties"
log_level="debug" log_file="c:/jk/logs/nsapi.log"</read>
<note>In the default object NameTrans section</note>
<read>NameTrans fn="assign-name" from="/servlet/*" name="servlet"</read>
<read>NameTrans fn="assign-name" from="/examples/*" name="servlet"</read>
<note>Create a new configuration object by adding the following lines to the end of
the obj.conf file</note>
<read><Object name=servlet></read>
<read>ObjectType fn=force-type type=text/plain</read>
<read>Service fn="jk_service" worker="worker1"</read>
<read></Object></read>
</screen>
<ul>
<li>
Restart Netscape (stop and start the server)
</li>
</ul>
<p>
That's all, now you should start tomcat and ask Netscape for
http://server:port/examples/
</p>
<subsection name="Adding additional Contexts">
<p>
The examples context is useful for verifying your installation, but you will also
need to add your own contexts.
Adding a new context requires two operations:
</p>
<ul>
<li>
Adding the context to Tomcat (I am not going to talk about this).
</li>
<li>
Assigning the NSAPI redirector to handle this context.
</li>
</ul>
<p>
Assigning the NSAPI redirector to handle this context is simple,
all you need to do is to edit <b>obj.conf</b> and add a NameTrans line that looks
like:
</p>
<screen>
<read>NameTrans fn="assign-name" from="/<context name>/*" name="servlet"</read>
</screen>
<p>
After saving <b>obj.conf</b> restart Netscape and it will serve the new context.
</p>
</subsection>
<subsection name="Advanced Context Configuration">
<p>
Sometimes it is better to have Netscape serve the static pages (html, gif, jpeg
etc.)
even if these files are part of a context served by Tomcat. For example, consider
the html and gif files in the examples context, there is no need to serve them from
the Tomcat process, Netscape will suffice.
</p>
<p>
Making Netscape serve static files that are part of the Tomcat contexts requires the
following:
</p>
<ul>
<li>
Configuring Netscape to know about the Tomcat contexts
</li>
<li>
Make sure that the WEB-INF directory is protected from access.
</li>
<li>
Configuring Netscape to assign the NSAPI redirector only specific requests that
requires JSP/Servlet handling.
</li>
</ul>
<p>
Adding a Tomcat context to Netscape requires the addition of a new Netscape virtual
directory
that covers the Tomcat context.
</p>
<p>
For example, adding a /example Netscape virtual directory that
covers the <b>c:\jakarta-tomcat\webapps\examples</b> directory.
</p>
<p>
To add a new virtual directory add the following line to your <b>obj.conf</b>:
</p>
<screen>
<read>NameTrans fn=pfx2dir from=/examples
dir="c:/jakarta-tomcat/webapps/examples"</read>
</screen>
<p>
WEB-INF protection requires some explanation; Each servlet application (context) has
a special directory named <b>WEB-INF</b>,
this directory contains sensitive configurations data and Java classes and must be
kept hidden from web users.
WEB-INF can be protected by adding the following line to the PathCheck section in
the default configuration object:
</p>
<screen>
<read>PathCheck fn="deny-existence" path="*/WEB-INF/*"</read>
<note>This line instructs the Netscape server to reject any request with a URL that
contain the path /WEB-INF/.</note>
</screen>
<p>
Configuring Netscape to assign the NSAPI redirector only specific requests is
somewhat harder,
you will need to specify the exact URL-Path pattern(s) that you want Tomcat to
handle
(usually only JSP files and servlets).
</p>
<p>
This requires a change to NemaTrans portion of <b>obj.conf</b>.
</p>
<screen>
<note>For the examples context it requires to replace the following line:</note>
<read>NameTrans fn="assign-name" from="/examples/*" name="servlet"</read>
<note>with the following two lines:</note>
<read>NameTrans fn="assign-name" from="/examples/jsp/*.jsp" name="servlet"</read>
<read>NameTrans fn="assign-name" from="/examples/servlet/*" name="servlet"</read>
</screen>
<p>
As you can see the second configuration is more explicit, it actually instructs
Netscape to assign the redirector with only requests to resources under
<b>/examples/servlet/</b> and resources under <b>/examples/</b> whose name ends with
<b>.jsp</b>.
</p>
<p>
You can be even more explicit and provide lines such as:
</p>
<screen>
<read>NameTrans fn="assign-name" from="/examples/servletname" name="servlet"</read>
<note>Instructs Netscape to assign the redirector request whose URL-Path equals
/example/servletname</note>
</screen>
</subsection>
<subsection name="Advanced Worker Configuration">
<p>
Sometimes you want to serve different contexts with different Tomcat processes
(for example to spread the load among different machines).
To achieve such goal you will need to define several workers and assign each context
with its own worker.
</p>
<p>
Defining workers is done in <b>workers.properties</b>, this file includes two types
of entries:
</p>
<screen>
<note>An entry that lists all the workers defined. For example:</note>
<read>worker.list=worker1, worker2</read>
<note>Entries that define the host and port associated with these workers.</note>
<read>worker.worker1.host=localhost</read>
<read>worker.worker1.port=8009</read>
<read>worker.worker1.type=ajp13</read>
<read>worker.worker2.host=otherhost</read>
<read>worker.worker2.port=8009</read>
<read>worker.worker2.type=ajp13</read>
</screen>
<p>
The above examples defined two workers, now we can use these workers to serve two
different
contexts each with it’s own worker.
Submitting requests to different workers is accomplished by using multiple Service
directives
in the servlet configuration Object, each with a different path pattern parameter.
</p>
<p>
For example, if we want to submit the <b>/examples</b> context to the worker named
<b>worker1</b> and the
<b>/webpages</b> context to the worker named <b>worker2</b> we should use the
following configuration:
</p>
<screen>
<read><Object name=servlet></read>
<read>ObjectType fn=force-type type=text/plain</read>
<read>Service fn="jk_service" worker="worker1" path="/examples/*"</read>
<read>Service fn="jk_service" worker="worker2" path="/webpages/*"</read>
<read>Service fn="jk_service" worker="worker1"</read>
<read></Object></read>
</screen>
<p>
More informations on using and configuring workers in the <a
href="jk/workershowto.html">Workers HowTO</a>
</p>
</subsection>
</section>
<section name="Building NSAPI redirector">
<p>
The redirector was developed using Visual C++ Ver.6.0, so having this environment is
a prereq if you want
to perform a custom build. You should also have NES developer SDK
The steps that you need to take are:
<ul>
<li>
Change directory to the nsapi plugins source directory.
</li>
<li>
Edit <b>nsapi.dsp</b> and update the include and library path to reflect your own
Netscape server installation
(search for a <b>/I compiler</b> option and <b>/libpath</b> linker option)
</li>
<li>
Make the source with MSDEV
</li>
</ul>
<screendos>
<notedos>Change directory to the nsapi plugins source directory</notedos>
<typedos>cd c:\home\apache\jk\nsapi</typedos>
<notedos>Build the sources using MSDEV</notedos>
<typedos>MSDEV nsapi.dsp /MAKE ALL</typedos>
</screendos>
</p>
<p>
If msdev is not in your path, enter the full path to msdev.exe.
This will build both release and debug versions of the redirector plugin.
An alternative will be to open the nsapi workspace file (nsapi.dsw) in msdev and
build it using the build menu.
</p>
</section>
</document>
1.1 jakarta-tomcat-connectors/jk/xdocs/jk/aphowto.xml
Index: aphowto.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1" ?>
<document>
<properties>
<title>Apache HowTo</title>
<author email="[EMAIL PROTECTED]">Henri Gomez</author>
<author email="[EMAIL PROTECTED]">Gal Shachor</author>
</properties>
<section name="Introduction">
<p>
This document explains how to connect Tomcat to the popular open source web server,
Apache.
There is actually to version of Apache, 1.3 and 2.0 and both could used mod_jk, the
Tomcat redirector
module
</p>
<p>
This document was originally part of <b>Tomcat: A Minimalistic User's Guide</b>
written by Gal Shachor,
but has been split off for organizational reasons.
</p>
<subsection name="Document Conventions and Assumptions">
<p>
${tomcat_home} is the root directory of tomcat.
Your Tomcat installation should have the following subdirectories:
<ul>
<li>
${tomcat_home}\conf - Where you can place various configuration files
</li>
<li>
${tomcat_home}\webapps - Containing example applications
</li>
<li>
${tomcat_home}\bin - Where you place web server plugins
</li>
</ul>
</p>
<p>
In all the examples in this document ${tomcat_home} will be <b>c:\jakarta-tomcat</b>.
A worker is defined to be a tomcat process that accepts work from the IIS server.
</p>
</subsection>
<subsection name="Supported Configuration">
<p>
The mod_jk module was developed and tested on:
<ul>
<li>
Linux, FreeBSD, AIX, HP-UX, MacOS X, and should works on major Unixes platforms
supporting Apache 1.3 and/or 2.0
</li>
<li>
WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs), Win2K
and WinXP and Win98
</li>
<li>
Cygwin (until you have an apache server and autoconf/automake support tools)
</li>
<li>
Netware
</li>
<li>
iSeries V5R1 and V5R2 with Apache 2.0.39. Be sure to have the latest Apache PTF
installed.
</li>
<li>
Tomcat 3.2.x, Tomcat 3.3.x, Tomcat 4.0.x, Tomcat 4.1.x and Tomcat 5
</li>
</ul>
</p>
<p>
The redirector uses <b>ajp12</b> and <b>ajp13</b> to send requests to the Tomcat
containers. There is also an option to use Tomcat in process,
more about the in-process mode can be found in the in process howto.
</p>
</subsection>
<subsection name="Who support ajp protocols ?">
<p>
The ajp12 protocol is only available in Tomcat 3.2.x and 3.3.x.
</p>
<p>
The <b>ajp12</b> has been <b>deprecated</b> with Tomcat 3.3.x and you should use
instead
<b>ajp13</b> which is the only ajp protocol known by Tomcat 4.0.x, 4.1.x and 5.
</p>
<p>
Of course Tomcat 3.2.x and 3.3.x also support ajp13 protocol.
</p>
<p>
Others servlet engines such as <b>jetty</b> have support for ajp13 protocol
</p>
</subsection>
<subsection name="How does it work ?">
<p>
In a nutshell a web server is waiting for client HTTP requests.
When these requests arrive the server does whatever is needed to serve the
requests by providing the necessary content.
</p>
<p>
Adding a servlet container may somewhat change this behavior.
Now the web server needs also to perform the following:
</p>
<ul>
<li>
Load the servlet container adapter library and initialize it (prior to serving
requests).
</li>
<li>
When a request arrives, it needs to check and see if a certain request belongs to a
servlet,
if so it needs to let the adapter take the request and handle it.
</li>
</ul>
<p>
The adapter on the other hand needs to know what requests it is going to serve,
usually based on some pattern in the request URL, and to where to direct these
requests.
</p>
<p>
Things are even more complex when the user wants to set a configuration that uses
virtual hosts,
or when they want multiple developers to work on the same web server
but on different servlet container JVMs.
We will cover these two cases in the advanced sections.
</p>
</subsection>
</section>
<section name="Building mod_jk on Unix">
<p>
The mod_jk build use the widely used configure system.
</p>
<subsection name="Prepare your mod_jk configure from CVS">
In case you get source from CVS, ie without an existing configure script,
you should have autoconf for configuration and installation.
<p>
To create jakarta-tomcat-connectors's autoconf script, you will need libtool 1.3.3
or higher,
and autoconf 2.13 or newer.
</p><p>
Those tools will not be required if you are just using a package downloaded from
apache.org,
they are only required for developers.
</p>
<p>
To create the configure script just type :
<screen>
<type>./buildconf.sh</type>
</screen>
</p>
</subsection>
<subsection name="Using configure to build mod_jk">
<p>Here's how to use configure to prepare mod_jk building, just type:
<source>
./configure [autoconf arguments] [jakarta-tomcat-connectors arguments]
</source>
</p>
<p>
You could set <b>CFLAGS</b> and <b>LDFLAGS</b> to add some platform specifics:
</p>
<screen>
<type>LDFLAGS=-lc ./configure -with-apxs=/home2/local/apache/bin/apxs</type>
</screen>
<p>
If you want to build mod_jk for Apache 1.3 and 2.0, you should
<ul>
<li>
use configure and indicate Apache 1.3 apxs location (--with-apxs)
</li>
<li>
use make
</li>
<li>
copy the mod_jk binary to the apache modules location
</li>
<li>
make clean (to remove all previously compiled modules)
</li>
<li>
use configure and indicate Apache 2.0 apxs location,
</li>
<li>
then make.
</li>
</ul>
</p>
</subsection>
<subsection name="configure arguments">
<p>
<table>
<tr><th>Apache related parameters</th><th></th></tr>
<tr>
<td>--with-apxs[=FILE]</td>
<td>FILE is the location of the apxs tool. Default is finding apxs in PATH.
It builds a shared Apache module. It detects automaticly the Apache version.
(2.0 and 1.3)</td>
</tr>
<tr><td>--with-apache=DIR</td>
<td>DIR is the path where apache sources are located.
The apache sources should have been configured before configuring mod_jk.
DIR is something like: /home/apache/apache_1.3.19
It builds a static Apache module.</td>
</tr>
<tr><td>--enable-EAPI</td>
<td>This parameter is needed when using Apache-1.3 and mod_ssl, otherwise you will
get the error message:
"this module might crash under EAPI!" when loading mod_jk.so in httpd.
Not needed when --with-apxs has been used</td>
</tr>
</table>
<br/>
<table>
<tr><th>JNI related parameters</th><th></th></tr>
<tr><td>--enable-jni</td>
<td>Build the JNI worker and so the build process will require
some informations about your Java Environment</td>
</tr>
<tr><td>--with-java-home=DIR</td>
<td>DIR is the patch to the JDK root directory. Something like:
/opt/java/jdk12</td>
</tr>
<tr><td>--with-os-type=SUBDIR</td><td>SUBDIR is the os-type subdirectory,
configure should guess it correctly.</td>
</tr>
<tr><td>--with-arch-type=SUBDIR</td><td>SUBDIR is the arch subdirectory,
configure should guess it correctly.</td>
</tr>
<tr><td>--with-java-platform=VAL</td><td>VAL is the Java platform 1 is 1.1.x and 2
is for 1.2 anf higher,
configure should guess it correctly.</td>
</tr>
</table>
</p>
</subsection>
<subsection name="Examples of configure use">
<screen>
<note>Apache 1.3 and 2.0 build</note>
<type>./configure --with-apxs=/usr/sbin/apxs</type><br/>
<type>make</type><br/>
<type>cp ./apache-1.3/mod_jk.so /usr/lib/apache</type><br/>
<type>make clean</type><br/>
<type>./configure --with-apxs=/usr/sbin/apxs2</type><br/>
<type>make</type><br/>
<type>cp ./apache-2.0/mod_jk.so /usr/lib/apache2</type><br/>
</screen>
<screen>
<note>Apache 2.0 build with JNI support</note>
<type>./configure --with-apxs=/opt/apache2/bin/apxs \</type>
<typenext>--with-java-home=${JAVA_HOME} --with-java-platform=2 \</typenext>
<typenext>--enable-jni</typenext><br/>
</screen>
<screen>
<note>Apache 1.3 build without JNI support</note>
<type>./configure --with-apxs=/usr/sbin/apxs</type><br/>
</screen>
</subsection>
</section>
<section name="Building mod_jk for Apache on Windows NT/2K/XP">
<p>
The module was developed using Visual C++ version 6.0, so having this environment is
a prerequisite
if you want to perform a custom build.
</p>
<p>
The steps that you need to take are:
</p>
<ul>
<li>
Change directory to the apache 1.3 or apache 2.0 source directory depending on your
version of Apache.
</li>
<li>
If you want to build mod_jk for Apache 1.3, set an <b>APACHE1_HOME</b> environment
variable which points
to where your Apache 1.3 is installed.
A mod_jk module for Apache 2.0 build will require <b>APACHE2_HOME</b> environment
variable to be set.
</li>
<li>
Copy mod_jk.dll to Apache's modules directory.
</li>
</ul>
<p>
An example on how to build mod_jk for Apache 1.3:
</p>
<screendos>
<notedos>Set location for Apache 1.3 sources</notedos>
<typedos>set APACHE1_HOME=c:\apache13</typedos>
<notedos>Change directory to the mod_jk module for Apache 1.3</notedos>
<typedos>cd c:\home\apache\jk\native\apache-1.3</typedos>
<notedos>Build the sources using MSDEV</notedos>
<typedos>MSDEV mod_jk.dsp /MAKE ALL</typedos>
<notedos>Copy the dll to your apache modules directory</notedos>
<typedos>cp release\mod_jk.dll c:\apache13\modules\</typedos>
</screendos>
<p>
An example on how to build mod_jk for Apache 2.0:
</p>
<screendos>
<notedos>Set location for Apache 2.0 sources</notedos>
<typedos>set APACHE2_HOME=c:\apache20</typedos>
<notedos>Change directory to the mod_jk module for Apache 2.0</notedos>
<typedos>cd c:\home\apache\jk\native\apache-2.0</typedos>
<notedos>Build the sources using MSDEV</notedos>
<typedos>MSDEV mod_jk.dsp /MAKE ALL</typedos>
<notedos>Copy the dll to your apache modules directory</notedos>
<typedos>cp release\mod_jk.dll c:\apache20\modules\</typedos>
</screendos>
<p>
If msdev is not in your path, enter the full path to msdev.exe.
Also, ApacheCore.lib is expected to exist in the <b>${APACHEX_HOME}\src\CoreD</b>
and
<b>${APACHEX_HOME}\src\CoreR</b> directories before linking will succeed.
You will need to build enough of the Apache source to create these libraries.
This will build both release and debug versions of the redirector plug-in (mod_jk).
An alternative will be to open mod_jk.dsp in msdev and build it using the build menu.
</p>
</section>
<section name="Building mod_jk for Apache on iSeries/OS400">
<p>
Since OS400 V4R5, iSeries (AS/400) used Apache 2.0 as their primary web server,
replacing the old IBM webserver.
It's now possible to build mod_jk on iSeries thanks to the help of IBM Rochester
Labs who provided informations and patches
to adapt mod_jk to their Operating System.
</p>
<p>
You should have at least Apache 2.0.39 which is provided in recent PTFs, a C
Compiler and IFS.
Since there's still no configure stuff on iSeries, you'll have to use the good
command line or use a CL with is present
in mod_jk source.
</p>
<ul>
<li>
Get the latest mod_jk source and untar it on a Windows or Unix boxes
</li>
<li>
Create a directory in IFS, ie /home/apache
</li>
<li>
Send the whole jk source directory to iSeries directory via FTP.
</li>
<li>
Then go to iSeries command line :
</li>
</ul>
<screen5250>
<note5250>Create mod_jk library</note5250>
<type5250>CRTLIB MOD_JK TEXT(‘Apache mod_jk tomcat connector module’)</type5250>
<note5250>Create service program source file</note5250>
<type5250>CRTSRCPF MOD_JK/QSRVSRC TEXT(‘Service program source file’)</type5250>
<note5250>Create the CL build program source file</note5250>
<type5250>CRTSRCPF FILE(MOD_JK/QCLSRC) TEXT(‘Build program source file’)</type5250>
<note5250>Edit the service program source file</note5250>
<type5250>STRSEU MOD_JK/QSRVSRC MOD_JK</type5250>
</screen5250>
<p>
In the edited file, specify that only jk_module should be exported :
<screen5250>
<type5250next> Columns . . : 1 71 Edit
MOD_JK/QSRVSRC </type5250next>
<type5250next> SEU==>
MOD_JK </type5250next>
<type5250next> *************** Beginning of data
************************************* </type5250next>
<type5250next>0001.00 STRPGMEXP PGMLVL(*CURRENT)
</type5250next>
<type5250next>0002.00 EXPORT SYMBOL("jk_module")
</type5250next>
<type5250next>0003.00 ENDPGMEXP
</type5250next>
<type5250next> ****************** End of data
**************************************** </type5250next>
</screen5250>
</p>
<p>
You could start to build all the modules of mod_jk :
</p>
<screen5250>
<note5250>Copy the CL build program source from IFS</note5250>
<type5250>CPYFRMSTMF FROMSTMF('/home/apache/jk/native/apache-2.0/bldjk.qcsrc')
+</type5250>
<type5250next>TOMBR('/QSYS.LIB/MOD_JK.LIB/QCLSRC.FILE/BLDJK.MBR')
MBROPT(*REPLACE)</type5250next>
<note5250>Build the CL build program</note5250>
<type5250>CRTCLPGM PGM(MOD_JK/BLDJK) SRCFILE(MOD_JK/QCLSRC) TEXT('Apache mod_jk
build program')</type5250>
<note5250>Launch the build</note5250>
<type5250>CALL MOD_JK/BLDJK</type5250><br/>
<note5250>If the build if successfull, copy the new mod_jk module</note5250>
<type5250>CRTDUPOBJ OBJ(MOD_JK) FROMLIB(MOD_JK) OBJTYPE(*SRVPGM) TOLIB(QHTTPSVR)
NEWOBJ(QZTCJK)</type5250>
</screen5250>
<p>
Next, you should restart your Apache 2.0 server and enjoy this piece of OpenSource
on iSeries.
</p>
</section>
</document>
1.1 jakarta-tomcat-connectors/jk/xdocs/jk/iishowto.xml
Index: iishowto.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1" ?>
<document>
<properties>
<title>IIS HowTo</title>
<author email="[EMAIL PROTECTED]">Henri Gomez</author>
<author email="[EMAIL PROTECTED]">Gal Shachor</author>
</properties>
<section name="Introduction">
<p>
This document explains how to set up IIS to cooperate with Tomcat.
</p>
<p>
Normally IIS can not execute Servlets and Java Server Pages (JSPs),
configuring IIS to use the mod_jk redirector plugin will let IIS send servlet and
JSP requests to Tomcat (and this way, serve them to clients).
</p>
<subsection name="Document Conventions and Assumptions">
<p>
${tomcat_home} is the root directory of tomcat.
Your Tomcat installation should have the following subdirectories:
<ul>
<li>
${tomcat_home}\conf - Where you can place various configuration files
</li>
<li>
${tomcat_home}\webapps - Containing example applications
</li>
<li>
${tomcat_home}\bin - Where you place web server plugins
</li>
</ul>
</p>
<p>
In all the examples in this document ${tomcat_home} will be <b>c:\jakarta-tomcat</b>.
A worker is defined to be a tomcat process that accepts work from the IIS server.
</p>
</subsection>
<subsection name="Supported Configuration">
<p>
The IIS-Tomcat redirector was developed and tested on:
<ul>
<li>
WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs), Win2K
and WinXP and Win98
</li>
<li>
IIS4.0 and PWS4.0
</li>
<li>
Tomcat 3.2.x, Tomcat 3.3.x, Tomcat 4.0.x, Tomcat 4.1.x and Tomcat 5
</li>
</ul>
</p>
<p>
The redirector uses <b>ajp12</b> and <b>ajp13</b> to send requests to the Tomcat
containers. There is also an option to use Tomcat in process,
more about the in-process mode can be found in the in process howto.
</p>
</subsection>
<subsection name="Who support ajp protocols ?">
<p>
The ajp12 protocol is only available in Tomcat 3.2.x and 3.3.x.
</p>
<p>
The <b>ajp12</b> has been <b>deprecated</b> with Tomcat 3.3.x and you should use
instead
<b>ajp13</b> which is the only ajp protocol known by Tomcat 4.0.x, 4.1.x and 5.
</p>
<p>
Of course Tomcat 3.2.x and 3.3.x also support ajp13 protocol.
</p>
<p>
Others servlet engines such as <b>jetty</b> have support for ajp13 protocol
</p>
</subsection>
<subsection name="How does it work ?">
<p>
<ol>
<li>
The IIS-Tomcat redirector is an IIS plugin (filter + extension), IIS load the
redirector plugin and calls its
filter function for each in-coming request.
</li>
<li>
The filter then tests the request URL against a list of URI-paths held inside
uriworkermap.properties,
If the current request matches one of the entries in the list of URI-paths,
the filter transfer the request to the extension.
</li>
<li>
The extension collects the request parameters and forwards them to the appropriate
worker using the defined
protocol like <b>ajp13</b>.
</li>
<li>
The extension collects the response from the worker and returns it to the browser.
</li>
</ol>
</p>
</subsection>
</section>
<section name="Installation">
<p>
A pre-built version of the ISAPI redirector server plugin, isapi_redirect.dll, is
available under
the win32/i386 directory of jakarta-tomcat-connectors distribution.
For those using Netscape as your browser, try downloading a zip version of the file,
if available.
There can be problems using Netscape to download DLL files.
You can also build a copy locally from the source present in
jakarta-tomcat-connectors distribution.
The Tomcat redirector requires three entities:
<ul>
<li>
<b>isapi_redirect.dll</b> - The IIS server plugin, either obtain a pre-built DLL or
build it yourself (see the build section).
</li>
<li>
<b>workers.properties</b> - A file that describes the host(s) and port(s) used by
the workers (Tomcat processes).
A sample workers.properties can be found under the conf directory.
</li>
<li>
<b>uriworkermap.properties</b> - A file that maps URL-Path patterns to workers.
A sample uriworkermap.properties can be found under the conf directory as well.
</li>
</ul>
</p>
<p>
The installation includes the following parts:
<ul>
<li>
Configuring the ISAPI redirector with a default /examples context and checking that
you can serve servlets with IIS.
</li>
<li>
Adding more contexts to the configuration.
</li>
</ul>
</p>
</section>
<section name="Configuring the ISAPI Redirector">
<p>
In this document I will assume that isapi_redirect.dll is placed in
<b>c:\jakarta-tomcat\bin\win32\i386\isapi_redirect.dll</b> and
that you created the properties files are in <b>c:\jakarta-tomcat\conf</b>.
</p>
<p>
<ol>
<li>
In the registry, create a new registry key named
<b>"HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi
Redirector\1.0"</b>
</li>
<li>
Add a string value with the name <b>extension_uri</b> and a value of
<b>/jakarta/isapi_redirect.dll</b>
</li>
<li>
Add a string value with the name <b>log_file</b> and a value pointing to where you
want your
log file to be (for example <b>c:\jakarta-tomcat\logs\isapi.log</b>).
</li>
<li>
Add a string value with the name <b>log_level</b> and a value for your log level
(can be debug, info, error or emerg).
</li>
<li>
Add a string value with the name <b>worker_file</b> and a value which is the full
path
to your workers.properties file (for example
<b>c:\jakarta-tomcat\conf\workers.properties</b>)
</li>
<li>
Add a string value with the name <b>worker_mount_file</b> and a value which is the
full path
to your uriworkermap.properties file (for example
<b>c:\jakarta-tomcat\conf\uriworkermap.properties</b>)
</li>
<li>
Using the IIS management console, add a new virtual directory to your IIS/PWS web
site.
The name of the virtual directory must be jakarta.
Its physical path should be the directory where you placed isapi_redirect.dll
(in our example it is c:\jakarta-tomcat\bin\win32\i386).
While creating this new virtual directory assign it with execute access.
</li>
<li>
Using the IIS management console, add isapi_redirect.dll as a filter in your IIS/PWS
web site.
The name of the filter should reflect its task (I use the name jakarta),
its executable must be our c:\jakarta-tomcat\bin\win32\i386\isapi_redirect.dll.
For PWS, you'll need to use regedit and add/edit the <b>"Filter DLLs"</b> key under
<b>HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\W3SVC\Parameters</b>.
This key contains a "," separated list of dlls ( full paths ) -
you need to insert the full path to isapi_redirect.dll.
</li>
<li>
Restart IIS (stop + start the IIS service), make sure that the jakarta filter is
marked with a green up-pointing arrow.
Under Win98 you may need to <b>cd WINDOWS\SYSTEM\inetsrv</b> and type PWS /stop
( the DLL and log files are locked - even if you click the stop button,
PWS will still keep the DLLs in memory. ). Type pws to start it again.
</li>
</ol>
</p>
<p>
That's all, you should now start Tomcat and ask IIS to serve you the /examples
context.
Try <a
href="http://localhost/examples/jsp/index.html";>http://localhost/examples/jsp/index.html</a>
for example and
execute some of the JSP examples.
</p>
<p>
If this does not work successfully, refer to the Troubleshooting section below for
help on correcting the problem.
</p>
<subsection name="Adding additional Contexts">
<p>
The examples context is useful for verifying your installation,
but you will also need to add your own contexts. Adding a new context requires two
operations:
</p>
<p>
<ol>
<li>
Adding the context to Tomcat (I am not going to talk about this).
</li>
<li>
Adding the context to the ISAPI redirector.
</li>
</ol>
</p>
<p>
Adding a context to the ISAPI redirector is simple, all you need to do is to edit
your uriworkermap.properties and to add a line that looks like:
</p>
<screen>
<read>/context/*=worker_name</read>
</screen>
<p>
Workers and their name are defined in workers.properties, by default
workers.properties comes
with a single pre-configured worker named <b>"defworker"</b> so you can use it.
As an example, if you want to add a context named "shop", the line that you should
add to
uriworkermap.properties will be:
</p>
<screen>
<read>/shop/*=defworker</read>
</screen>
After saving uriworkermap.properties restart IIS and it will serve the new context.
<p>
A feature is present till Tomcat 3.2, where a uriworkermap.properties-auto is
automatically
written each time Tomcat is started. This file includes settings for each of the
contexts that
Tomcat will serve during its run.
</p>
<p>
Each context has settings to have Tomcat handle servlet and JSP requests,
but by default static content is left to be served by IIS.
</p>
<p>
Each context also has a commented out setting to have Tomcat handle all requests to
the context.
You can rename this file (so it won't be overwritten the next time Tomcat is
started) and
uncomment this setting or make other customizations.
</p>
<p>
You may also use this file as is in your worker_mount_file setting.
</p>
</subsection>
<subsection name="Advanced Context Configuration">
<p>
Sometimes it is better to have IIS serve the static pages (html, gif, jpeg etc.)
even if these files are part of a context served by Tomcat.
</p>
<p>
For example, consider the html and gif files in the examples context, there is no
need
to serve them from the Tomcat process, IIS will suffice.
</p>
<p>
Making IIS serve static files that are part of the Tomcat contexts requires the
following:
<ol>
<li>
Configuring IIS to know about the Tomcat contexts
</li>
<li>
Configuring the redirector to leave the static files for IIS
</li>
</ol>
</p>
<p>
Adding a Tomcat context to IIS requires the addition of a new IIS virtual directory
that covers the Tomcat context.
For example adding a /example IIS virtual directory that covers the
c:\jakarta-tomcat\webapps\examples directory.
</p>
<p>
Configuring the redirector is somewhat harder, you will need to specify the exact
URL-Path pattern(s) that you want Tomcat to handle (usually only JSP files and
servlets).
This requires a change to the uriworkermap.properties :
<screen>
<note>For the examples context it requires to replace the following line</note>
<read>/examples/*=defworker</read>
<note>with the following two lines</note>
<read>/examples/*.jsp=defworker</read>
<read>/examples/servlet/*=defworker</read>
</screen>
</p>
<p>
As you can see the second configuration is more explicit, it actually instruct the
redirector
to redirect only requests to resources under /examples/servlet/ and resources under
/examples/
whose name ends with .jsp.
This is similar to what is automically written to the uriworkermap.properties-auto
file for each context.
</p>
<p>
You can even be more explicit and provide lines such as:
<screen>
<read>/example/servletname=defworker</read>
</screen>
</p>
<p>
that instructs the redirector to redirect request whose URL-Path equals
/example/servletname
to the worker named defworker.
</p>
</subsection>
<subsection name="Protecting the WEB-INF Directory">
<p>
Each servlet application (context) has a special directory named WEB-INF,
this directory contains sensitive configurations data and Java classes and must be
kept hidden from web users.
Using the IIS management console it is possible to protect the WEB-INF directory
from user access,
this however requires the administrator to remember that.
</p>
<p>
To avoid this need the redirector plugin automatically protects your WEB-INF
directories by rejecting
any request that contains WEB-INF in its URL-Path.
</p>
</subsection>
<subsection name="Advanced Worker Configuration">
<p>
Sometimes you want to serve different contexts with different Tomcat processes
(for example to spread the load among different machines).
To achieve such goal you will need to define several workers and assign each context
with its own worker.
</p>
<p>
Defining workers is done in workers.properties, this file includes two types of
entries:
</p>
<p>
<screen>
<note>An entry that lists all the workers defined</note>
<read>worker.list=worker1, worker2</read>
<note>Entries that define the host and port associated with these workers</note>
<read>worker.worker1.host=localhost</read>
<read>worker.worker1.port=8009</read>
<read>worker.worker1.type=ajp13</read>
<read>worker.worker2.host=otherhost</read>
<read>worker.worker2.port=8009</read>
<read>worker.worker2.type=ajp13</read>
</screen>
</p>
<p>
The above example defined two workers, now we can use these workers to serve two
different contexts
each with its own worker :
<screen>
<note>example uriworkermap.properties fragment</note>
<read>/examples/*=worker1</read>
<read>/webpages/*=worker2</read>
</screen>
</p>
<p>
As you can see the <b>examples</b> context is served by <b>worker1</b> while the
<b>webpages</b> context is served by <b>worker2</b>.
</p>
<p>
More informations on using and configuring workers in the <a
href="jk/workershowto.html">Workers HowTO</a>
</p>
</subsection>
</section>
<section name="Building ISAPI redirector">
<p>
The redirector was developed using Visual C++ Ver.6.0, so having this environment is
a prereq if you want
to perform a custom build. You should also have IIS developer SDK
The steps that you need to take are:
<ul>
<li>
Change directory to the isapi plugins source directory.
</li>
<li>
Make the source with MSDEV
</li>
</ul>
<screendos>
<notedos>Change directory to the isapi plugins source directory</notedos>
<typedos>cd c:\home\apache\jk\isapi</typedos>
<notedos>Build the sources using MSDEV</notedos>
<typedos>MSDEV isapi.dsp /MAKE ALL</typedos>
</screendos>
</p>
<p>
If msdev is not in your path, enter the full path to msdev.exe.
This will build both release and debug versions of the redirector plugin.
An alternative will be to open the isapi workspace file (isapi.dsw) in msdev and
build it using the build menu.
</p>
</section>
<section name="Troubleshooting">
<p>
It is easy to have the ISAPI redirector not work the first time you try to install
it.
</p>
<p>
If this happens to you, here are some steps to follow to try to correct the problem.
</p>
<p>
These steps aren't guaranteed to cover all possible problems,
but they should help find the typical mistakes.
</p>
<p>
If you make any corrections during these steps, restart the IIS service as described
above in the last step
of the installation, then retry the step.
</p>
<p>To enable error tracking, make sure web site activity is being logged.
For PWS 4.0 make sure "Save Web Site Activity Log" is checked in the Advanced
Options of the Personal Web Manager.
</p>
<p>
Note: These steps assume your <b>worker_mount_file</b> setting points to an
unmodified copy of the
<b>uriworkermap.properties</b> file.<br/>
Results may be misleading if <b>worker_mount_file</b> points to a modified
<b>uriworkermap.properties</b>
or the <b>uriworkermap.properties-auto</b> file.<br/>
It is also assumed that the <b>"/examples" context</b> works correcly if you access
Tomcat directly.
</p>
<subsection name="Win98">
<p>
Start the IIS service and Tomcat.
</p>
<p>
Check for the presence of the ISAPI redirector log file you specified in the
log_file setting.
If not found, verify the following:
</p>
<ul>
<li>
Check the "Filter DLLs" setting in the
"HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\W3SVC\Parameters"
key and make sure the path is correct.
</li>
<li>
Check the spelling of the "HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software
Foundation\Jakarta Isapi Redirector\1.0" key.
Case isn't important, but an incorrect letter will prevent the isapi_redirect.dll
from finding its registry settings.
</li>
<li>
Check the log_file setting for typos, name and data. Also insure the directory in
which the log file will appear already exists.
</li>
If the above are set correctly, the ISAPI redirector should be able to create the
log file.
</ul>
<p>
Invoke the URL <a
href="http://localhost/examples/jsp/index.html";>http://localhost/examples/jsp/index.html</a>
in your browser.
Case is important in Tomcat. The characters following "localhost" in the URL must be
lower case.
If the page fails to appear, stop the IIS service (required to view the IIS log
file).
Then examine the last line in the IIS log file in found in SYSTEM/LogFiles/W3SVC1 :
</p>
<p>
If the last line contains:
</p>
<screen>
<read>GET "/examples/jsp/index.html HTTP/1.1" 404</read>
</screen>
<p>
then the ISAPI redirector is not recognizing that it should be handling requests for
the "/examples" context.
Check the following:
</p>
<ul>
<li>
Check the extension_uri name for typos.
</li>
<li>
Check the worker_file setting for typos, name and data.
</li>
<li>
Check the worker_mount_file setting typos, name and data.
</li>
If these are set correctly, the ISAPI redirector should recognize that it should
handle requests for the "/examples" context.
</ul>
<p>If the last line contains something like:
</p>
<screen>
<read>GET "/jakarta/isapi_redirect.dll HTTP1.1"</read>
</screen>
<p>
then the ISAPI redirector is recognizing that it should handle the request,
but is not successful at getting Tomcat to service the request.
</p>
<p>
You should check the HTTP error code following GET "/..." :
</p>
<screen>
<note>Error 404</note>
<read>GET "/..." 404</read>
</screen>
<ul>
<li>
Make sure you entered the URL correctly.
</li>
<li>
Make sure the virtual directory created was called "jakarta".
It should display in Personal Web Manager as "/jakarta" (without the quotes).
</li>
<li>
Make sure the extension_uri data begins with "/jakarta/" (without the quotes).
</li>
</ul>
<screen>
<note>Error 500</note>
<read>GET "/..." 500</read>
</screen>
<ul>
<li>
Make sure that "isapi_redirect.dll" follows "/jakarta/" in the extension_uri setting.
</li>
<li>
Check the workers.properties file and make sure the port setting for
worker.ajp12.port is the same as the port specified in the server.xml for the "Apache
AJP12 support".
</li>
</ul>
<screen>
<note>Error 200 or 403</note>
<read>GET "/..." 200</read>
<read>GET "/..." 403</read>
</screen>
<ul>
<li>
Make sure you have checked Execute Access
for the jakarta virtual directory in the Advanced Options of the Personal Web
Manager.
</li>
</ul>
<p>
If the above settings are correct, the index.html page should appear in your
browser.
You should also be able to click the Execute links to execute the JSP examples.
</p>
</subsection>
<subsection name="WinNT/Win2K/WinXP">
<p>
Start the World Wide Web Publishing Service and Tomcat.
</p>
<p>
Check for the presence of the ISAPI redirector log file you specified in the
log_file setting.
If not found, check the following:
</p>
<ul>
<li>
Check the "executable" you set for the filter in the IIS Management Console and make
sure the path is correct.
</li>
<li>Check the spelling of the "HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software
Foundation\Jakarta Isapi Redirector\1.0" key.
Case isn't important, but an incorrect letter will prevent the isapi_redirect.dll
from finding its registry settings.
</li>
<li>
Check the log_file setting for typos, name and data. Also insure the directory in
which the log file will appear already exists.
</li>
If the above are set correctly, the ISAPI redirector should be able to create the
log file.
</ul>
<p>
Check the jakarta filter you added and make sure its status shows a green
upward-pointing arrow.
If not, check the following:
</p>
<ul>
<li>
Check the worker_file setting for typos, name and data.
</li>
<li>
Check the worker_mount_file setting typos, name and data.
</li>
If the above are set correctly, the green upward-pointing arrow should appear, even
if the other settings are wrong.
</ul>
<p>
Invoke the URL <a
href="http://localhost/examples/jsp/index.html";>http://localhost/examples/jsp/index.html</a>
in your browser. Case is important in Tomcat. The characters following "localhost"
in the URL must be lower case.
If the page fails to appear, examine the last line in the IIS server log file in
found in SYSTEM32/LogFiles/W3SVC1.
</p>
<p>
The last line should contain something like: GET "/jakarta/isapi_redirect.dll
HTTP1.1",
which indicates the ISAPI redirector is recognizing that it should handle the
request.
</p>
<p>
You should check the HTTP error code following GET "/..." :
</p>
<screen>
<note>Error 404</note>
<read>GET "/..." 404</read>
</screen>
<ul>
<li>
Make sure you entered the URL correctly.
</li>
</ul>
<screen>
<note>Error 500</note>
<read>GET "/..." 500</read>
</screen>
<ul>
<li>
Make sure the virtual directory created was called "jakarta".
</li>
<li>
Make sure that the extension_uri setting is correct.
</li>
<li>
Check the workers.properties file and make sure the port setting for
worker.ajp12.port is the same as the port specified in the server.xml for the "Apache
AJP12 support".
</li>
</ul>
<screen>
<note>Error 200 or 403</note>
<read>GET "/..." 200</read>
<read>GET "/..." 403</read>
</screen>
<ul>
<li>
Make sure you have checked Execute Access for the jakarta virtual directory in the
Advanced Options of the Personal Web Manager.
</li>
</ul>
<p>
If the above settings are correct, the index.html page should appear in your
browser.
You should also be able to click the Execute links to execute the JSP examples.
</p>
</subsection>
</section>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
