Knowledge Base

Setting up a re-direct to Tomcat using the Jakarta ISAPI Redirector

Last Modified:
05 Apr 2019
User Level:

Setting up a re-direct to Tomcat using the Jakarta ISAPI Redirector


  • IIS 8 and the manager interface has been installed on the server
  • Your web server is set to run on port 443
  • Tomcat is listening on port 8009 for AJP connections (default).
  • Your TERMINALFOUR context defined within your application server is called 'terminalfour.'
  • Your server has been secured. Do not enable any of the following without ensuring this.

If any of the above is untrue please carefully read the settings below and alter them where appropriate.


Create a New Folder for the Redirect Files

Create a folder on your disk to store the files required for this redirect. Having spaces in the path to this folder can be problematic so avoid this. 

These files are usually placed within the Tomcat folder but this can make removing older versions of Tomcat problematic after an upgrade. For this reason, it is suggested you place the folder outside of Tomcat's folder.


Download the latest JK connector (isapi_redirect-X.X.XX.dll)  for your operating system from here:

Rename the DLL file to isapi_redirect.dll and place it into the folder created above.

Configuration Files

Create the following three files on your server as plain text files. Their names must match what's below and the paths in must be altered to use the path to your new folder created above. Once the files have been created, place them with the DLL file from above.

# Configuration file for the Jakarta ISAPI Redirector

# The path to the ISAPI Redirector Extension, relative to the website
# This must be in a virtual directory with execute privileges

# Full path to the log file for the ISAPI Redirector

# Log level (debug, info, warn, error or trace)

# Full path to the file

# Full path to the file

# Basic worker definition for Jakarta ISAPI Redirector


# Basic URI mapping file for IIS - Jakarta ISAPI Redirector
# [URL] = [WORKER]


Jakarta IIS Virtual Directory

  1. Locate your website within IIS , if you do not have a site defined within ISS then use the default website. 
  2. Create a new virtual directory call jakarta
    IIS8 Jakarta Virtual Directory 
  3. Select the folder you created above as it's home folder
  4. Give the virtual folder Read, Run scripts and Execute permissions
    IIS8 Jakarta Directory permissions

Adding Required Server Roles/Features

  1. open the Server Manager Console
  2. Click on "Add roles and features"
  3. Go to "Features" and locate "WinRM IIS Extension"
    IIS 8 Add Roles And Features
  4. Press "Install"
  5. This will add the "ISAPI Extensions" and "ISAPI Filters" Server Roles

Adding the ISAPI DLL to IIS

  1. Click on the IIS Site you created the Virtual Directory in open the Isapi Filters page
    IIS8 Site Home
  2. Click Add on the right side of the page
  3. Enter a Name for the filter (this can be anything you like, it's for reference only) 
  4. Enter the path to the isapi_redirect.dll file as the Executable
    IIS8 Isapi Redirect Filter
  5. Click Ok, and you'll see the filter listed.


Handler Mappings

  1. In the Connections panel, select the website you added the ISAPI filter to above, i.e. 'Default Web Site'
  2. Click 'Handler Mappings'
  3. Highlight 'ISAPI-dll' by clicking on it
  4. In the right panel, Actions, click 'Edit Feature Permissions...'
  5. In the pop-up window, check 'Execute' box, click OK

Error pages

In order for specific error messages to be passed to the front-end user you must permit Detailed errors on your website in IIS. To do this:

  1. Click on the web site in IIS
  2. Choose 'Error Pages'
  3. Choose 'Edit feature settings' from the Actions menu on the right
  4. Set the Error Responses to 'Detailed errors' 
  5. Choose 'OK' to save the changes

Testing the Connector

From your server navigate to http://localhost/terminalfour/SiteManager. If the configuration above is correct, then you should see the TERMINALFOUR TERMINALFOUR login screen. 

If your site requires a host header be sure to use that in your URL instead of localhost.

Potential Issues

If you experience problems getting the filter to load then ensure that the file permissions are correct for the folder you've created. The user set for anonymous access should be able to read this directory.  

Back to top