Return-Path: Mailing-List: contact tomcat-dev-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list tomcat-dev@jakarta.apache.org Received: (qmail 49610 invoked by uid 500); 3 May 2000 12:48:20 -0000 Delivered-To: apmail-jakarta-tomcat-cvs@apache.org Received: (qmail 49607 invoked by uid 1115); 3 May 2000 12:48:19 -0000 Date: 3 May 2000 12:48:19 -0000 Message-ID: <20000503124819.49606.qmail@locus.apache.org> From: shachor@locus.apache.org To: jakarta-tomcat-cvs@apache.org Subject: cvs commit: jakarta-tomcat/src/doc in-process-howto.html tomcat-iis-howto.html tomcat-netscape-howto.html shachor 00/05/03 05:48:19 Added: src/doc in-process-howto.html tomcat-iis-howto.html tomcat-netscape-howto.html Log: Put the Netscape and IIS howtos in the correct place Revision Changes Path 1.1 jakarta-tomcat/src/doc/in-process-howto.html Index: in-process-howto.html =================================================================== In-Process Howto

In-Process HowTo

By Gal Shachor <shachor@il.ibm.com>

This document explains how to set up Netscape/IIS web servers so that Tomcat will run inside the web server process. It assumes that you have already followed the instructions in the web server specific howto and configured it to use Tomcat as an out of process servlet container.

Normally Tomcat is running in one process and the web servers runs in another; this however requires the web server to communicate using some IPC mechanism such as TCP/IP.
When Tomcat is running inside the web server process, requests for servlet execution are passed using JNI (and performance improves).

Note: Running the JVM inside the web server is not always a good idea. Sure it gives the best performance, but is lacks the stability associated with the out of process mode of operation. When deciding to run in-process make sure that top speed is what you need.

Document Conventions and Assumptions

<tomcat_home> is the root directory of tomcat. Your Tomcat installation should have the following subdirectories:

<tomcat_home>\conf - Where you can place various configuration files
<tomcat_home>\webapps - Containing example applications
<tomcat_home>\bin - Where you place web server plugins

In all the examples in this document <tomcat_home> will be d:\tomcat.

A worker is defined to be a Tomcat process that accepts work from the web server.

Supported Configuration

For in-process operation you will have to use the Netscape/IIS redirectors, look at their supported configuration sections.

The in-process adapter was tested using JDK1.1.7b/IBM's JDK 1.1.7/JDK1.2.2.

Installation

The in-process adapter is not part of the "official" build of Jakarta, You can obtain the code and binaries needed for it by accessing http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/win32/i386/. The adapter related file is jni_connect.dll.

The Tomcat JNI adapter requires the following actions:

Putting jni_connect.dll in the bin directory - jni_connect.dll is used to issue callbacks from Tomcat back to the web server, either obtain a pre-built DLL or build it yourself (see the build section).
Update workers.properties and add the JNI worker - The JNI worker needs several configuration items, you will need to add those to the worker properties file.
Updating server.xml - You need to instruct Tomcat to use the JNI connection handlers. You will also need to provide the home property for your ContextManager (later on the log files and work directories will be created under this home).
Directing context(s) to the in-process Tomcat - You need to instruct the redirector to send work to the in-process Tomcat
Restart your server (so changes will take effect)

Putting jni_connect.dll in the bin directory

Put jni_connect.dll inside <tomcat_home>\bin\i386\.

Update worker.properties and add the JNI worker

You should provide the JNI worker with several settings, some are mandatory and some are an option...

You should define a JNI worker.
Set the worker.list property to point on a worker named jni: worker.list=jni
Announce that the worker named jni is of type jni: worker.jni.type=jni
You should set a classpath to be use by the in-process Tomcat.
To set the classpath use the worker.name.class_path property, for example:
worker.jni.class_path=d:\tomcat\classes
worker.jni.class_path=d:\tomcat\lib\xml.jar
worker.jni.class_path=d:\tomcat\lib\jasper.jar
worker.jni.class_path=d:\tomcat\lib\servlet.jar
worker.jni.class_path=d:\tomcat\lib\webserver.jar
worker.jni.class_path=d:\sdk\jdk1.2.2\lib\tools.jar
Note: Do not forget to include the JDK's tools.jar in your classpath.
You should provide a full path to the dll implementing the JVM. For JDK1.1.x it is javai.dll, for JDK1.2.x it is jvm.dll. For example:
worker.jni.jvm_lib=d:\sdk\jdk1.2.2\jre\bin\classic\jvm.dll
You should provide command line options for Tomcat; you must provide a -config option to specify your JNI configured server.xml. For example:
worker.jni.cmd_line=-config
worker.jni.cmd_line=d:\tomcat\conf\jni_server.xml
You should specify the tomcat home location as a Java system properties. For example:
worker.jni.sysprops=tomcat.home=d:\tomcat
You can specify additional Java system properties. For example:
worker.jni.sysprops=java.compiler=NONE
You can specify files to by used by the JVM for stdout and stderr. For example:
worker.jni.stdout=d:\jvm.stdout
worker.jni.stderr=d:\jvm.stderr
You can specify additional PATH, to be use when loading dlls (useful when you are using native code). For example:
worker.jni.ld_path=d:\SQLLIB\bin
worker.jni.ld_path=d:\my\native\code

You can find a sample worker file (jni_workers.properties) under tomcat/conf.

Update server.xml

By default Tomcat reads the file <tomcat_home>\conf\server.xml. This file defines among other things the contexts and connectors used by Tomcat. In order to work in-process you will have to perform the following actions:

You should update the connectors list.
Remove all the connectors from your server.xml and add the following lines (note that you will need to update the area marked with <tomcat_home>)

      <!-- New JNI, you need to compile the new/experimental module -->
      <Connector className="org.apache.tomcat.service.JNIEndpointConnector">
          <Parameter name="native_lib" value="<tomcat_home>\bin\i386\jni_connect.dll"/>
      </Connector>

These lines add a JNI connector to Tomcat.

You should update the home attribute used by the ContextManager so that the ContextManager will know where to place the log, work and webapps directories. For example:
```
      <ContextManager debug="0" workDir="work" home="<tomcat_home>" />
      .
      .
      .
      </ContextManager />
    
```
Again, make sure that you update <tomcat_home> to your real Tomcat root.

You can find a sample server file (jni_server.xml) under jakarta-tomcat/conf.

Redirect contexts to the JNI workers

You will need to select the contexts that you wish to serve using your jni worker.

On Netscape you can do that by modifying the lines in the servlet configuration object to reflect redirect work to the new JNI worker. For example:

      <Object name=servlet>
      ObjectType fn=force-type type=text/plain
      Service fn="jk_service" worker="jni"
      </Object>

On IIS you will have to modify your worker mount file to mount contexts to the JNI worker. For example:

/examples/*=jni

When you are done restart your server. That's all, you should now be able to execute Tomcat in-process.

Building the JNI connector dll

The JNI connector was developed using Visual C++ Ver.6.0, so having this environment is a prereq if you want to perform a custom build. You will also need a JDK installation (the jre is not good enough) in order to use the JDK's include files.

The steps that you need to take are:

Change directory to the JNI connector source directory.
Make sure that the environment variable JAVA_HOME is set and points to your JDK installation
Execute the following command:
MSDEV jni_connect.dsp /MAKE ALL
If msdev is not in your path, enter the full path to msdev.exe

This will build both release and debug versions of the JNI connector.

An alternative will be to open the jni_connect workspace file (jni_connect.dsw) in msdev and build it using the build menu.

How does it work?

Working in-process requires both the server redirector (IIS-Tomcat/Netscape-Tomcat) and the in-process connector. The server redirector can direct work to different workers based on their name; now that we added the JNI worker the server redirector can forward it work... The basic operation is this:

During the initialization the server redirector starts the JNI worker.
Upon startup the JNI worker creates a JVM inside the web server and starts Tomcat in it.
For each in-coming request for a servlet, the server redirector will check which worker is responsible for the specific context. If this worker is the JNI worker then the request is assigned to it.
The JNI worker attaches to the JVM and submits the request into the Tomcat engine (using the JNIEndpointConnector). Tomcat will then execute the request.
The server redirector collects the response from the JNI worker and returns it to the browser.

Feedback

Please send feedback, bug report or any additional information to tomcat-dev@jakarta.apache.org.

1.1 jakarta-tomcat/src/doc/tomcat-iis-howto.html Index: tomcat-iis-howto.html =================================================================== Tomcat IIS HowTo

Tomcat IIS HowTo

By Gal Shachor <shachor@il.ibm.com>

This document explains how to set up IIS to cooperate with Tomcat. Normally IIS can not execute Servlets and Java Server Pages (JSPs), configuring IIS to use the Tomcat redirector plugin will let IIS send servlet and JSP requests to Tomcat (and this way, serve them to clients).

Document Conventions and Assumptions

<tomcat_home> is the root directory of tomcat. Your Tomcat installation should have the following subdirectories:

<tomcat_home>\conf - Where you can place various configuration files
<tomcat_home>\webapps - Containing example applications
<tomcat_home>\bin - Where you place web server plugins

In all the examples in this document <tomcat_home> will be d:\tomcat.

A worker is defined to be a tomcat process that accepts work from the IIS server.

Supported Configuration

The IIS-Tomcat redirector was developed and tested on:

WinNT4.0-i386 SP4/SP5/SP6a (it should be able to work on other versions of the NT service pack.)
IIS4.0 and PWS4.0
Tomcat3.0 - Tomcat3.1beta

The redirector uses ajp12 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.

Installation

The IIS redirector is not part of the "official" build of Jakarta, You can obtain the code and binaries needed for it by accessing http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/win32/i386/. The redirector related file is isapi_redirect.dll.

The Tomcat redirector requires three entities:

isapi_redirect.dll - The IIS server plugin, either obtain a pre-built DLL or build it yourself (see the build section).
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 tomcat/conf.
uriworkermap.properties - A file that maps URL-Path patterns to workers. A sample uriworkermap.properties can be found in the CVS under tomcat/conf.

The installation includes the following parts:

Configuring the ISAPI redirector with a default /examples context and checking that you can serve servlets with IIS.
Adding more contexts to the configuration.

Configuring the ISAPI Redirector

In this document I will assume that isapi_redirect.dll is placed in d:\tomcat\bin\iis\i386\isapi_redirect.dll and that you created the properties files are in d:\tomcat\conf.

In the registry, create a new registry key named
"HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi Redirector\1.0"
Add a string value with the name extension_uri and a value of /jakarta/isapi_redirect.dll
Add a string value with the name log_file and a value pointing to where you want your log file to be (for example d:\tomcat\isapi.log)
Add a string value with the name log_level and a value for your log level (can be debug, inform, error or emerg).
Add a string value with the name worker_file and a value of D:\tomcat\conf\workers.properties (you can copy this file from the CVS)
Add a string value with the name worker_mount_fileand a value of D:\tomcat\conf\uriworkermap.properties (you can copy this file from the CVS)
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 d:\tomcat\bin\iis\i386). While creating this new virtual directory assign it with execute access.
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 d:\tomcat\bin\iis\i386\isapi_redirect.dll. For PWS, you'll need to use regedit and add/edit the "Filter DLLs" key under HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\W3SVC\Parameters. This key contains a "," separated list of dlls ( full paths ) - you need to insert the full path to isapi_redirect.dll.
Restart IIS (stop + start the IIS admin server), make sure that the jakarta filter is marked with a green up-pointing arrow.
(costin)Under Win98 you may need to cd WINDOWS\SYSTEM\inetsrv 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.

That's all, you should now start tomcat and ask IIS to serve you the /examples context.

Adding additional Contexts

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:

Adding the context to Tomcat (I am not going to talk about this).
Adding the context to the ISAPI redirector.

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:

/context/*=worker_name

Workers and their name are defined in workers.properties, by default workers.properties comes with a single pre-configured worker named "ajp12" 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:

/shop/*=ajp12

After saving uriworkermap.properties restart IIS and it will serve the new context.

Building the redirector

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.

The steps that you need to take are:

Change directory to the isapi plugins source directory.
Execute the following command:
MSDEV isapi.dsp /MAKE ALL
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.

How does it work?

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.
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.
The extension collects the request parameters and forwards them to the appropriate worker using the ajp12 protocol.
The extension collects the response from the worker and returns it to the browser.

Advanced Context Configuration

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. 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.

Making IIS serve static files that are part of the Tomcat contexts requires the following:

Configuring IIS to know about the Tomcat contexts
Configuring the redirector to leave the static files for IIS

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 d:\tomkat\webapps\examples directory.

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. For the examples context it requires to replace the following line:

/examples/*=ajp12

with the following two lines:

/examples/*.jsp=ajp12 /examples/servlet/*=ajp12

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. You can even be more explicit and provide lines such as:

/example/servletname=ajp12

that instructs the redirector to redirect request whose URL-Path equals /example/servletname to the worker named ajp12.

Protecting the WEB-INF Directory

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. 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.

Advanced Worker Configuration

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.

Defining workers is done in workers.properties, this file includes two types of entries:

An entry that lists all the workers defined. For example:
worker.list=ajp12, ajp12second
Entries that define the host and port associated with these workers. For example:
worker.ajp12.host=localhost worker.ajp12.port=8007 worker.ajp12second.host=otherhost worker.ajp12second.port=8007

The above examples defined two workers, now we can use these workers to serve two different contexts each with its own worker. For example look at the following uriworkermap.properties fragment:

/examples/*=ajp12 /webpages/*=ajp12second

As you can see the examples context is served by ajp12 while the webpages context is served by ajp12second.

Feedback

Please send feedback, bug report or any additional information to tomcat-user@jakarta.apache.org

1.1 jakarta-tomcat/src/doc/tomcat-netscape-howto.html Index: tomcat-netscape-howto.html =================================================================== Jakarta IIS Howto

Tomcat Netscape HowTo

By Gal Shachor <shachor@il.ibm.com>

This document explains how to set up Netscape web servers to cooperate with Tomcat. 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.

Document Conventions and Assumptions

<tomcat_home> is the root directory of tomcat. Your Tomcat installation should have the following subdirectories:

<tomcat_home>\conf - Where you can place various configuration files
<tomcat_home>\webapps - Containing example applications
<tomcat_home>\bin - Where you place web server plugins

In all the examples in this document <tomcat_home> will be d:\tomcat.

A worker is defined to be a tomcat process that accepts work from the Netscape server.

Supported Configuration

The Netscape-Tomcat redirector was developed and tested on:

WinNT4.0-i386 SP4/SP5/SP6a (it should be able to work on other versions of the NT service pack and also UNIX)
Netscape Enterprise 3.0 and 3.61
Tomcat3.0 - Tomcat3.1beta1

The redirector uses ajp12 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.

Installation

The Netscape redirector is not part of the "official" build of Jakarta, You can obtain the code and binaries needed for it by accessing http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/win32/i386/. The redirector related file is nsapi_redirect.dll.

The Tomcat redirector requires two entities:

nsapi_redirect.dll - The Netscape server plugin, either obtain a pre-built DLL or build it yourself (see the build section).
workers.properties - A file that describes the host(s) and port(s) used by the workers (Tomcat processes). This file is located in (tomcat/conf/workers.properties).

The installation includes the following parts:

Configuring the NSAPI redirector with a default /examples context and checking that you can serve servlets with Netscape.
Adding more contexts to the configuration.

Configuring the NSAPI Redirector

In this document I will assume that nsapi_redirect.dll is placed in d:\tomcat\bin\netscape\nt4\i386\nsapi_redirect.dll and that you created the properties files are in d:\tomcat\conf.

If the Netscape built in servlet support is working disable it.
Add the redirector plugin into the Netscape server configuration. Edit your server obj.conf and add the following lines:

In the Init section:
Init fn="load-modules" funcs="jk_init,jk_service" shlib="d:/tomcat/bin/netscape/nt4/i386/nsapi_redirect.dll" Init fn="jk_init" worker_file="d:/tomcat/conf/workers.properties" log_level="debug" log_file="d:/tomcat/nsapi.log"
In the default object NameTrans section
NameTrans fn="assign-name" from="/servlet/*" name="servlet" NameTrans fn="assign-name" from="/examples/*" name="servlet"
Create a new configuration object by adding the following lines to the end of the obj.conf file:
<Object name=servlet> ObjectType fn=force-type type=text/plain Service fn="jk_service" worker="ajp12" </Object>

Restart Netscape (stop and start the server)

That's all, now you should start tomcat and ask Netscape for http://server:port/examples/

Adding additional Contexts

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:

Adding the context to Tomcat (I am not going to talk about this).
Assigning the NSAPI redirector to handle this context.

Assigning the NSAPI redirector to handle this context is simple, all you need to do is to edit obj.conf and add a NameTrans line that looks like:

NameTrans fn="assign-name" from="/<context name>/*" name="servlet"

After saving obj.conf restart Netscape and it will serve the new context.

Building the redirector

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.

The steps that you need to take are:

Change directory to the nsapi plugins source directory.
Edit nsapi.dsp and update the include and library path to reflect your own Netscape server installation (search for a /I compiler option and /libpath linker option)
Execute the following command:
MSDEV nsapi.dsp /MAKE ALL
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.

How does it work?

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.
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.
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.
Netscape will execute our jk_service extension. The extension collects the request parameters and forwards them to the appropriate worker using the ajp12 protocol (the worker="ajp12" parameter in jk_service inform it that the worker for this request is named ajp12).
The extension collects the response from the worker and returns it to the browser.

Advanced Context Configuration

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.

Making Netscape serve static files that are part of the Tomcat contexts requires the following:

Configuring Netscape to know about the Tomcat contexts
Make sure that the WEB-INF directory is protected from access.
Configuring Netscape to assign the NSAPI redirector only specific requests that requires JSP/Servlet handling.

Adding a Tomcat context to Netscape requires the addition of a new Netscape virtual directory that covers the Tomcat context. For example, adding a /example Netscape virtual directory that covers the d:\tomkat\webapps\examples directory. To add a new virtual directory add the following line to your obj.conf:

NameTrans fn=pfx2dir from=/examples dir="d:/tomcat/webapps/examples"

WEB-INF protection requires some explanation; 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. WEB-INF can be protected by adding the following line to the PathCheck section in the default configuration object:

PathCheck fn="deny-existence" path="*/WEB-INF/*"

This line instructs the Netscape server to reject any request with a URL that contain the path /WEB-INF/.

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). This requires a change to NemaTrans portion of obj.conf. For the examples context it requires to replace the following line:

NameTrans fn="assign-name" from="/examples/*" name="servlet"

with the following two lines:

NameTrans fn="assign-name" from="/examples/jsp/*.jsp" name="servlet" NameTrans fn="assign-name" from="/examples/servlet/*" name="servlet"

As you can see the second configuration is more explicit, it actually instructs Netscape to assign the redirector with only requests to resources under /examples/servlet/ and resources under /examples/ whose name ends with .jsp. You can be even more explicit and provide lines such as:

NameTrans fn="assign-name" from="/examples/servletname" name="servlet"

that instructs Netscape to assign the redirector request whose URL-Path equals /example/servletname.

Advanced Worker Configuration

Defining workers is done in workers.properties, this file includes two types of entries:

An entry that lists all the workers defined. For example:
worker.list=ajp12, ajp12second
Entries that define the host and port associated with these workers. For example:
worker.ajp12.host=localhost worker.ajp12.port=8007 worker.ajp12second.host=otherhost worker.ajp12second.port=8007

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. For example, if we want to submit the /servlet context to a worker named ajp12 and the /examples context to a worker named ajp12second we should use the following configuration:

<Object name=servlet> ObjectType fn=force-type type=text/plain Service fn="jk_service" worker="ajp12" path="/servlet/*" Service fn="jk_service" worker="ajp12second" path="/examples/*" Service fn="jk_service" worker="ajp12" </Object>

Feedback

Please send feedback, bug report or any additional information to tomcat-user@jakarta.apache.org.