1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
|
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="../images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>The Apache Tomcat Connectors - Web Server HowTo (1.2.50) - ISAPI redirector for Micrsoft IIS HowTo</title><meta name="author" content="Henri Gomez"><meta name="author" content="Gal Shachor"><meta name="author" content="Yoav Shapira"></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="http://tomcat.apache.org/"><img alt="Tomcat Home" src="../images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="../images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>The Apache Tomcat Connectors - Web Server HowTo</h1><div class="versionInfo">
Version 1.2.50,
<time datetime="2024-08-08">Aug 8 2024</time></div><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="../index.html">Docs Home</a></li></ul></div><div><h2>Common HowTo</h2><ul><li><a href="../common_howto/quick.html">Quick Start</a></li><li><a href="../common_howto/workers.html">All About Workers</a></li><li><a href="../common_howto/timeouts.html">Timeouts</a></li><li><a href="../common_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../common_howto/proxy.html">Reverse Proxy</a></li></ul></div><div><h2>Web Server HowTo</h2><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>Reference Guide</h2><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a href="../reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>AJP Protocol Reference</h2><ul><li><a href="../ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul></div><div><h2>Miscellaneous Documentation</h2><ul><li><a href="../miscellaneous/faq.html">Frequently Asked Questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></li><li><a href="http://issues.apache.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=Tomcat+Connectors&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li></ul></div><div><h2>News</h2><ul><li><a href="../news/20240101.html">2024</a></li><li><a href="../news/20230101.html">2023</a></li><li><a href="../news/20200201.html">2020</a></li><li><a href="../news/20180301.html">2018</a></li><li><a href="../news/20160901.html">2016</a></li><li><a href="../news/20150101.html">2015</a></li><li><a href="../news/20140201.html">2014</a></li><li><a href="../news/20120301.html">2012</a></li><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/20100101.html">2010</a></li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>ISAPI redirector for Micrsoft IIS HowTo</h2><h3 id="Introduction">Introduction</h3><div class="text">
<p>
This document explains how to set up the ISAPI redirector for IIS to cooperate with Tomcat.
</p>
<p>
Normally IIS can not execute Servlets and Java Server Pages (JSPs).
Configuring IIS to use the ISAPI redirector plugin will let IIS send servlet and
JSP requests to Tomcat (and this way, serve them to clients).
</p>
<p>
It is recommended that you also read the
<a href="../common_howto/workers.html">Workers HowTo</a> document
to learn how to setup the working entities between your web server and Tomcat Engines.
For more detailed configuration information consult the Reference Guide for
<a href="../reference/workers.html">workers.properties</a>,
<a href="../reference/uriworkermap.html">uriworkermap</a>
and <a href="../reference/iis.html">IIS</a>.
</p>
<div class="subsection"><h4 id="Document_Conventions_and_Assumptions">Document Conventions and Assumptions</h4><div class="text">
<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:\tomcat</b>.
A worker is defined to be a tomcat process that accepts work from the IIS server.
</p>
</div></div>
<div class="subsection"><h4 id="Supported_Configuration">Supported Configuration</h4><div class="text">
<p>
The IIS to Tomcat redirector is supported for:
</p>
<ul>
<li>IIS running on any currently supported version of Windows</li>
<li>All currently supported versions of Tomcat</li>
</ul>
<p>
The redirector may work with IIS running on older, unsupported versions of
Windows and/or Tomcat but such configurations are not supported.
</p>
</div></div>
<div class="subsection"><h4 id="AJP_protocols?">AJP protocols?</h4><div class="text">
<p>
The redirector uses the AJP protocol to send requests to the Tomcat containers.
The AJP version used is <b>ajp13</b>. All current versions Tomcat support the
ajp13 protocol. Others servlet engines such as <b>Jetty</b> and <b>JBoss</b>
also support the ajp13 protocol.
</p>
<p>
The <b>ajp12</b> protocol has been <b>deprecated</b> and you should no longer use it.
The <b>ajp14</b> protocol is considered experimental.
</p>
</div></div>
<div class="subsection"><h4 id="How_does_it_work_?">How does it work ?</h4><div class="text">
<p>
<ol>
<li>
The ISAPI redirector is a Microsoft IIS plugin (filter + extension). IIS loads
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 transfers 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>
</div></div>
</div><h3 id="Installation">Installation</h3><div class="text">
<p>
Pre-built versions of the ISAPI redirector plugin, isapi_redirect.dll, for
32-bit and 64-bit environments are available from the
<a href="https://tomcat.apache.org/download-connectors.cgi">Apache Tomcat
Connectors Downloads</a> page.
You can also build a copy locally from the Tomcat Connectors source
distribution.
The ISAPI redirector requires three entities:
<ul>
<li>
<b>isapi_redirect.dll</b> - The ISAPI redirector for Microsoft IIS plugin,
either obtain a pre-built DLL or build it yourself (see the build section).
</li>
<li>
<b><a href="../reference/workers.html">workers.properties</a></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><a href="../reference/uriworkermap.html">uriworkermap.properties</a></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>
<div class="subsection"><h4 id="Configuring_the_ISAPI_Redirector">Configuring the ISAPI Redirector</h4><div class="text">
<p>These instructions have been written based on Windows Server 2012 R2 and
tested with all supported Windows operating systems up to Windows 11 / Windows
Server 2022.
</p>
<p>
These installation instructions have been tested with a default installation of
IIS plus ISAPI Extensions and Filters on a clean, fully patched OS installation
with Tomcat 9 installed in <b>C:\Program Files\Apache Software Foundation\Tomcat
9.0</b>. This is referred to as ${tomcat_home} for the remainder of this
document.
</p>
<ol>
<li>
Create a directory <b>${tomcat_home}\isapi</b>
</li>
<li>
Allow the IIS process to create the ISAPI redirector log file. Modify the path
as necessary if the log file is to be written to a different directory. Enter
the following at a command prompt:
<div class="codeBox"><pre><code>>icacls "C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi" /grant "IIS APPPOOL\DefaultAppPool":(OI)(CI)M
</code></pre></div>
On client operating systems with User Account Control (UAC) enabled, the command
prompt must be opened using <b>Run as administrator</b> for the above command to
complete successfully.
</li>
<li>
Download the appropriate (32-bit or 64-bit) isapi_redirect.dll for your
operating system and place it in <b>${tomcat_home}\isapi</b>
</li>
<li>
Set the premissions for isapi_redirect.dll. On Windows Server 2019 it appears to be
necessary to explicitly set the permissions for this dll. Enter
the following at a command prompt:
<div class="codeBox"><pre><code>>icacls "C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\isapi_redirect.dll" /grant "Everyone":RX
</code></pre></div>
</li>
<li>
Create <b>${tomcat_home}\isapi\isapi_redirect.properties</b> file to configure the ISAPI
redirctor. Configuration can also be performed via registry settings - see
below. The contents of this file should be:
<div class="codeBox"><pre><code>extension_uri=/jakarta/isapi_redirect.dll
log_file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\isapi_redirect.log
log_level=info
worker_file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\workers.properties
worker_mount_file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\uriworkermap.properties
</code></pre></div>
Be careful so that Windows does not add a <b>.txt</b> extension to the file.
</li>
<li>
Create <b>${tomcat_home}\isapi\workers.properties</b> file to configure the Tomcat
instances that requests will be passed to. For a single Tomcat instance on the
local machine the contents of this file should be:
<div class="codeBox"><pre><code>worker.list=tomcat01
worker.tomcat01.type=ajp13
worker.tomcat01.host=localhost
worker.tomcat01.port=8009
</code></pre></div>
</li>
<li>
Create <b>${tomcat_home}\isapi\uriworkermap.properties</b> file to configure which
requests will be passed to Tomcat. To expose the examples web application the
contents of this file should be:
<div class="codeBox"><pre><code>/examples/*=tomcat01
</code></pre></div>
</li>
<li>
Using the IIS management console, add a new virtual directory to your IIS web
site. In a clean install, this will be the <b>Default Web Site</b>. The name of
the virtual directory must be <b>jakarta</b>. Its physical path should be the
directory where you placed <b>isapi_redirect.dll</b>.
</li>
<li>
Select the newly created virtual directory in the management console and then
double-click <b>Handler Mappings</b>. Select the (currently disabled)
<b>ISAPI-dll</b> entry and then click <b>Edit Feature Permissions</b> in the
action pane. In the dialog box that opens, select <b>Execute</b> so all three
permissions are selected. Click <b>OK</b> and <b>ISAPI-dll</b> should now be in
the enabled state.
</li>
<li>
Again using the IIS management console, add the ISAPI redirector as a filter to
your web site. Select your web site and then double-click <b>ISAPI Filters</b>.
From the action pane, click <b>Add...</b>. For the filter name use <b>tomcat</b>
and the executable should be the full path to <b>isapi_redirect.dll</b>. Once
configured, click <b>OK</b>.
</li>
<li>
Still using the IIS management console, configure the ISAPI redirector as
allowed. Select your server (not the web site) and then double-click on <b>ISAPI
and CGI Restrictions</b>. From the action pane, click <b>Add...</b>. Select the
isapi_redirect.dll, add a descripion (e.g. tomcat) and select the <b>Allow
extension path to execute</b> and then click <b>OK</b>.
</li>
<li>
Restart IIS (stop + start the IIS service).
</li>
</ol>
<p>
That's all, you should now start Tomcat and ask IIS to serve you the /examples
context. Try <a href="http://localhost/examples/">http://localhost/examples/</a>
for example and execute some of the Servlet or JSP examples.
</p>
<p>
If this does not work successfully, refer to the Troubleshooting section below for help on correcting the problem.
</p>
</div></div>
<div class="subsection"><h4 id="IIS_logging">IIS logging</h4><div class="text">
<p>
If the IIS access logs show entries such as <b>/jakarta/isapi_redirect.dll</b>
rather than <b>/examples/servlets</b> then this can be corrected via the IIS
management console. Select your server (not the web site) and then double-click
on <b>Modules</b>. In the <b>Actions</b> pane, click
<b>View Ordered List...</b>, select the <b>IsapiFilterModule</b> and move it up
until it is above the <b>HttpLoggingModule</b>.
</p>
</div></div>
<div class="subsection"><h4 id="Registry_configuration">Registry configuration</h4><div class="text">
<p>
As an alternative to using the <b>isapi_redirector.properties</b> file, the
ISAPI redirector may be configured via the registry. To do this, follow these
steps:
</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:\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:\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:\tomcat\conf\uriworkermap.properties</b>)
</li>
</ol>
</div></div>
<div class="subsection"><h4 id="64_Bit_notes">64 Bit notes</h4><div class="text">
<p>
In a 64-bit environment the IIS Application Pool should have "Enable 32-bit
Applications" set to "False". To check this, select <b>Application Pools</b> in
the IIS management console, then right-click on the pool you are using and
select <b>Set Application Pool Defaults...</b>. <b>Enable 32-bit
Applications</b> may be found in the <b>General</b> section. If this is not
configured correctly, the redirector will not be called and IIS will return an
HTTP code 404.
</p>
<p>
You must use the 64-bit version of the ISAPI redirector on 64-bit operating
systems. If you attempt to use the 32-bit version, you will get an HTTP code 500
for every request because the library is not loadable into a 64-bit IIS.
</p>
</div></div>
<div class="subsection"><h4 id="Adding_additional_Contexts">Adding additional Contexts</h4><div class="text">
<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 (not discussed here).
</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>
<div class="codeBox"><pre><code>/context/*=worker_name
</code></pre></div>
<p>
Workers and their name are defined in workers.properties. As an example, if you
want to add a context named "shop", to be served by the worker named "tomcat01"
the line that you should add to uriworkermap.properties will be:
</p>
<div class="codeBox"><pre><code>/shop/*=tomcat01
</code></pre></div>
After saving uriworkermap.properties restart IIS and it will serve the new
context.
<p>
The above should be all you need for IIS to pass through to Tomcat any request
for any URI which corresponds to a Tomcat context (webapp).
</p>
</div></div>
<div class="subsection"><h4 id="Advanced_Context_Configuration">Advanced Context Configuration</h4><div class="text">
<p>
If your website is very busy (more than 100 requests/second, or more than 100
simultaneous client connections), it might sometimes be desirable to have IIS
serve static content (html, gif, jpeg etc.) directly, even if these files are
part of a context served by Tomcat. Allowing IIS to serve such files directly
may avoid the small overhead consisting of passing the request to Tomcat via
the redirector, and may free up Tomcat somewhat, by using it only to process
requests that only Tomcat can handle (e.g. requests to JSP pages and java
servlets).
</p>
<p>
For example, consider the html and gif files in the examples context: you could
serve these files directly with IIS; there is no need to serve them from the
Tomcat process.
</p>
<warn>However, you should be very careful when you implement the following
configuration style, because by doing so you are in fact providing a "back-door"
to IIS, and allowing it to serve files out of a Tomcat context without Tomcat's
knowledge, thus bypassing any security restrictions which Tomcat itself and the
Tomcat context (webapp) may place on those files.</warn>
<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:\tomcat\webapps\examples directory.
</p>
<p>
Configuring the redirector is somewhat harder, you will need to specify the
exact URL-Path pattern(s) which you want Tomcat to handle (usually only JSP
files and servlets). This requires a change to the uriworkermap.properties:
<div class="codeBox"><pre><code>For the examples context it requires to replace the following line
/examples/*=tomcat01
with the following two lines
/examples/*.jsp=tomcat01
/examples/servlet/*=tomcat01
</code></pre></div>
</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.
</p>
<p>
You can even be more explicit and provide lines such as:
<div class="codeBox"><pre><code>/example/servlets/chat=tomcat01
</code></pre></div>
</p>
<p>
that instructs the redirector to redirect all requests whose URL-path matches
the leading string "/example/servlets/chat" to the worker named tomcat01.
</p>
</div></div>
<div class="subsection"><h4 id="Protecting_the_content_of_your_Tomcat_contexts">Protecting the content of your Tomcat contexts</h4><div class="text">
<p>Once again, be aware that by allowing IIS to access the content of your
Tomcat context directly, you are potentially bypassing Tomcat's protection of
that content. You should thus make sure to protect this content at the IIS level
if needed, by using the corresponding IIS management console functions.
</p>
<p>
In particular, each servlet application (context) has a special directory named
WEB-INF, which contains sensitive configuration data and Java classes, and which
should always be kept hidden from web users. Using the IIS management console
it is possible to protect the WEB-INF directory from user access, but
considering that this is a general requirement, and considering that it is easy
to forget to implement this protection at the IIS level, the ISAPI redirector
plugin does it automatically for you, and it will reject any request which
contains WEB-INF in its URL path. It will also reject any request which contains
META-INF in its URL path.
</p>
</div></div>
<div class="subsection"><h4 id="Advanced_Worker_Configuration">Advanced Worker Configuration</h4><div class="text">
<p>
Sometimes you may want to serve different contexts with different Tomcat
processes (for example to spread the load among different machines). To achieve
such a goal you will need to define several workers and assign each context to
its own worker.
</p>
<p>
Defining additional workers is done in the workers.properties file. This file
includes two types of entries:
</p>
<p>
<div class="codeBox"><pre><code># An entry that lists all the workers defined
worker.list=worker1, worker2
# Entries that define the host and port associated with each of these workers
worker.worker1.host=localhost
worker.worker1.port=8009
worker.worker1.type=ajp13
worker.worker2.host=otherhost
worker.worker2.port=8009
worker.worker2.type=ajp13
</code></pre></div>
</p>
<p>
The above example defined two workers, now we can use these workers to serve two
different contexts each with its own worker:
<div class="codeBox"><pre><code>example uriworkermap.properties fragment
/examples/*=worker1
/webpages/*=worker2
</code></pre></div>
</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 information on using and configuring workers in the
<a href="../common_howto/workers.html">Workers HowTo</a> and in the
<a href="../reference/workers.html">worker.properties configuration reference</a>.
</p>
</div></div>
</div><h3 id="Building_the_ISAPI_redirector">Building the ISAPI redirector</h3><div class="text">
<p>
To build the ISAPI redirector you will need Mladen's Custom Microsoft Compiler.
The remainder of this document assumes this installed to c:\cmsc.
</p>
<p>
The steps to build the ISAPI redirector are:
<ul>
<li>
Download the sources as a zip file and unpack it.
</li>
<li>
Change directory to the ISAPI redirector source directory.
</li>
<li>
<div class="codeBox"><pre><code>c:\cmsc\setenv.bat x86
nmake -f Makefile.vc
c:\cmsc\setenv.bat x64
nmake -f Makefile.vc
</code></pre></div>
</li>
</ul>
</p>
<p>
The resulting file isapi_redirect.dll (and the debug symbol file
isapi_redirect.pdb) is located in the "x86_RELEASE" or "x64_RELEASE"
sub directory.
</p>
</div><h3 id="Troubleshooting">Troubleshooting</h3><div class="text">
<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>
Note: These steps are based on the configuration used in the installation
instructions that proxies requests for the examples web application to a single
Tomcat instance. It is also assumed that the <b>"/examples" context</b> works
correctly if you access Tomcat directly.
</p>
<div class="subsection"><h4 id="Diagnostics_steps">Diagnostics steps</h4><div class="text">
<p>
Delete (or move elsewhere) the ISAPI redirector log file if present.
</p>
<p>
Start the IIS service and Tomcat.
</p>
<p>
Check for the presence of the ISAPI redirector log file at the specified
location. If not found, that indicates that the ISAPI redirector has not started
correctly. This is usually caused by incorrect configuration settings.
<ul>
<li>
Check your configuration carefully against the installation instructions,
particularly the location, name and contents of the
<b>${tomcat_home}\isapi\isapi_redirect.properties</b> file.
</li>
<li>
If using the registry based configuration, check the path, name and values of
the registry keys. Registry names are not case sensitive.
</li>
<li>
Check that the directory specified for the log file exists and that the file
permissions have been configured as per the installation instructions.
</li>
</ul>
If the above are set correctly, the ISAPI redirector should be able to create
the log file.
</p>
<p>
Invoke the URL
<a href="http://localhost/examples/">http://localhost/examples/</a> in your
browser. Case is important in URLs. 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 C:\inetpub\logs\LogFiles\W3SVC1:
</p>
<p>
If the last line contains:
<div class="codeBox"><pre><code>GET "/examples/ HTTP/1.1" 404
</code></pre></div>
then the ISAPI redirector is not recognising that it should be handling requests
for the "/examples" context.
</p>
<p>
If the last line contains something like:
<div class="codeBox"><pre><code>GET "/jakarta/isapi_redirect.dll HTTP1.1"
</code></pre></div>
then the ISAPI redirector is recognising that it should handle the request, but
is not successful at getting Tomcat to service the request.
</p>
<p>
Check the following:
<ul>
<li>
Check your configuration carefully against the installation instructions,
particularly the name of the virtual directory and the location, name and
contents of the <b>${tomcat_home}\isapi\uriworkermap.properties</b> and
<b>${tomcat_home}\isapi\workers.properties</b> files.
</li>
If these are set correctly, the ISAPI redirector should recognise that it should
handle requests for the "/examples" context.
</ul>
</p>
<p>
If the browser shows a 503 error page then the ISAPI redirector is recognising
that it should handle the request but is not receiving a timely response from
Tomcat. Check the following:
<ul>
<li>
Check your configuration carefully against the installation instructions,
particularly the location, name and
<b>${tomcat_home}\isapi\workers.properties</b> file.
</li>
<li>
Check the AJP connector configuration in Tomcta matches the configuration in the
<b>${tomcat_home}\isapi\workers.properties</b> file.
</li>
</ul>
</p>
<p>
If the browser shows a 500 error page then an internal error has occurred within
IIS or the ISAPI redirector when trying to serve the request. There should be a
textual description of the error towards the top of the page and an 8-digit hex
error code towards the end of the page. The last four digits should be the
standard windows error code associated with the problem.
</p>
<p>
A common cause of 500 errors is Windows creating configuration files with hidden
".txt" file extensions that are not shown in Windows Explorer. Even if file
extensions are shown for other files, double check to make sure that Windows
Explorer is configured to show file extensions for all files.
</p>
<p>
If the error message is <b>Calling GetFilterVersion on ISAPI filter
"...isapi_redirect.dll" failed</b> and the code is <b>0x8007047e</b> then the
code translates to an error code 0x047e or 1150 which is "The specified program
requires a newer version of Windows". Together these indicate that the
initialisation of the ISAPI redirector failed because the configuration could
not be read - either from <b>${tomcat_home}\isapi\isapi_redirect.properties</b>
of from the registry. Check the name location and contents of the
<b>${tomcat_home}\isapi\isapi_redirect.properties</b> file or the registry keys
as appropriate.
</p>
<p>
If the above settings are correct, the index.html page should appear in your browser.
You should also be able to click the links to execute some Servlet or JSP examples.
</p>
</div></div>
</div></div></div></div></div><footer><div id="footer">
Copyright © 1999-2024, The Apache Software Foundation
</div></footer></div></body></html>
|
