You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by co...@apache.org on 2002/02/21 00:45:04 UTC
cvs commit: jakarta-tomcat-connectors/jk/java/org/apache/jk/server/tomcat33/config ApacheConfig.java BaseJkConfig.java IISConfig.java NSConfig.java
costin 02/02/20 15:45:04
Added: jk/java/org/apache/jk/server/tomcat33/config
ApacheConfig.java BaseJkConfig.java IISConfig.java
NSConfig.java
Log:
Importing the config generators from tomcat3.3
Jk2 should be functionally equivalent with jk1. Most of this
stuff will be refactored to be common for both 4.x and 3.x ( and
other versions/servers ).
Revision Changes Path
1.1 jakarta-tomcat-connectors/jk/java/org/apache/jk/server/tomcat33/config/ApacheConfig.java
Index: ApacheConfig.java
===================================================================
/* $Id: ApacheConfig.java,v 1.1 2002/02/20 23:45:03 costin Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.jk.server.tomcat33.config;
import org.apache.tomcat.core.*;
import org.apache.tomcat.util.io.FileUtil;
import org.apache.tomcat.util.log.*;
import java.io.*;
import java.util.*;
/* The idea is to keep all configuration in server.xml and
the normal apache config files. We don't want people to
touch apache ( or IIS, NES ) config files unless they
want to and know what they're doing ( better than we do :-).
One nice feature ( if someone sends it ) would be to
also edit httpd.conf to add the include.
We'll generate a number of configuration files - this one
is trying to generate a native apache config file.
Some web.xml mappings do not "map" to server configuration - in
this case we need to fallback to forward all requests to tomcat.
Ajp14 will add to that the posibility to have tomcat and
apache on different machines, and many other improvements -
but this should also work for Ajp12, Ajp13 and Jni.
*/
/**
Generates automatic apache mod_jk configurations based on
the Tomcat server.xml settings and the war contexts
initialized during startup.
<p>
This config interceptor is enabled by inserting an ApacheConfig
element in the <b><ContextManager></b> tag body inside
the server.xml file like so:
<pre>
* < ContextManager ... >
* ...
* <<b>ApacheConfig</b> <i>options</i> />
* ...
* < /ContextManager >
</pre>
where <i>options</i> can include any of the following attributes:
<ul>
<li><b>configHome</b> - default parent directory for the following paths.
If not set, this defaults to TOMCAT_HOME. Ignored
whenever any of the following paths is absolute.
</li>
<li><b>jkConfig</b> - path to use for writing Apache mod_jk conf file. If
not set, defaults to
"conf/auto/mod_jk.conf".</li>
<li><b>workersConfig</b> - path to workers.properties file used by
mod_jk. If not set, defaults to
"conf/jk/workers.properties".</li>
<li><b>modJk</b> - path to Apache mod_jk plugin file. If not set,
defaults to "modules/mod_jk.dll" on windows,
"modules/mod_jk.nlm" on netware, and
"libexec/mod_jk.so" everywhere else.</li>
<li><b>jkLog</b> - path to log file to be used by mod_jk.</li>
<li><b>jkDebug</b> - JK Loglevel setting. May be debug, info, error, or emerg.
If not set, defaults to emerg.</li>
<li><b>jkWorker</b> The desired worker. Must be set to one of the workers
defined in the workers.properties file. "ajp12", "ajp13"
or "inprocess" are the workers found in the default
workers.properties file. If not specified, defaults
to "ajp13" if an Ajp13Interceptor is in use, otherwise
it defaults to "ajp12".</li>
<li><b>forwardAll</b> - If true, forward all requests to Tomcat. This helps
insure that all the behavior configured in the web.xml
file functions correctly. If false, let Apache serve
static resources. The default is true.
Warning: When false, some configuration in
the web.xml may not be duplicated in Apache.
Review the mod_jk conf file to see what
configuration is actually being set in Apache.</li>
<li><b>noRoot</b> - If true, the root context is not mapped to
Tomcat. If false and forwardAll is true, all requests
to the root context are mapped to Tomcat. If false and
forwardAll is false, only JSP and servlets requests to
the root context are mapped to Tomcat. When false,
to correctly serve Tomcat's root context you must also
modify the DocumentRoot setting in Apache's httpd.conf
file to point to Tomcat's root context directory.
Otherwise some content, such as Apache's index.html,
will be served by Apache before mod_jk gets a chance
to claim the request and pass it to Tomcat.
The default is true.</li>
</ul>
<p>
@author Costin Manolache
@author Larry Isaacs
@author Mel Martinez
@version $Revision: 1.1 $ $Date: 2002/02/20 23:45:03 $
*/
public class ApacheConfig extends BaseJkConfig {
/** default path to mod_jk .conf location */
public static final String MOD_JK_CONFIG = "conf/auto/mod_jk.conf";
/** default path to workers.properties file
This should be also auto-generated from server.xml.
*/
public static final String WORKERS_CONFIG = "conf/jk/workers.properties";
/** default mod_jk log file location */
public static final String JK_LOG_LOCATION = "logs/mod_jk.log";
/** default location of mod_jk Apache plug-in. */
public static String MOD_JK;
//set up some defaults based on OS type
static{
String os = System.getProperty("os.name").toLowerCase();
if(os.indexOf("windows")>=0){
MOD_JK = "modules/mod_jk.dll";
}else if(os.indexOf("netware")>=0){
MOD_JK = "modules/mod_jk.nlm";
}else{
MOD_JK = "libexec/mod_jk.so";
}
}
private File jkConfig = null;
private File modJk = null;
// ssl settings
private boolean sslExtract=true;
private String sslHttpsIndicator="HTTPS";
private String sslSessionIndicator="SSL_SESSION_ID";
private String sslCipherIndicator="SSL_CIPHER";
private String sslCertsIndicator="SSL_CLIENT_CERT";
Hashtable NamedVirtualHosts=null;
public ApacheConfig() {
}
//-------------------- Properties --------------------
/**
set the path to the output file for the auto-generated
mod_jk configuration file. If this path is relative
then it will be resolved absolutely against
the getConfigHome() path.
<p>
@param <b>path</b> String path to a file
*/
public void setJkConfig(String path){
jkConfig= (path==null)?null:new File(path);
}
/**
set the path to the mod_jk Apache Module
@param <b>path</b> String path to a file
*/
public void setModJk(String path){
modJk=( path==null?null:new File(path));
}
/** By default mod_jk is configured to collect SSL information from
the apache environment and send it to the Tomcat workers. The
problem is that there are many SSL solutions for Apache and as
a result the environment variable names may change.
The following JK related SSL configureation
can be used to customize mod_jk's SSL behaviour.
Should mod_jk send SSL information to Tomact (default is On)
*/
public void setExtractSSL( boolean sslMode ) {
this.sslExtract=sslMode;
}
/** What is the indicator for SSL (default is HTTPS)
*/
public void setHttpsIndicator( String s ) {
sslHttpsIndicator=s;
}
/**What is the indicator for SSL session (default is SSL_SESSION_ID)
*/
public void setSessionIndicator( String s ) {
sslSessionIndicator=s;
}
/**What is the indicator for client SSL cipher suit (default is SSL_CIPHER)
*/
public void setCipherIndicator( String s ) {
sslCipherIndicator=s;
}
/** What is the indicator for the client SSL certificated(default
is SSL_CLIENT_CERT
*/
public void setCertsIndicator( String s ) {
sslCertsIndicator=s;
}
// -------------------- Initialize/guess defaults --------------------
/** Initialize defaults for properties that are not set
explicitely
*/
protected void initProperties(ContextManager cm) {
super.initProperties(cm);
jkConfig=FileUtil.getConfigFile( jkConfig, configHome, MOD_JK_CONFIG);
workersConfig=FileUtil.getConfigFile( workersConfig, configHome,
WORKERS_CONFIG);
if( modJk == null )
modJk=new File(MOD_JK);
else
modJk=FileUtil.getConfigFile( modJk, configHome, MOD_JK );
jkLog=FileUtil.getConfigFile( jkLog, configHome, JK_LOG_LOCATION);
}
// -------------------- Generate config --------------------
/**
executes the ApacheConfig interceptor. This method generates apache
configuration files for use with mod_jk. If not
already set, this method will setConfigHome() to the value returned
from <i>cm.getHome()</i>.
<p>
@param <b>cm</b> a ContextManager object.
*/
public void execute(ContextManager cm) throws TomcatException {
try {
initProperties(cm);
initWorker(cm);
NamedVirtualHosts = new Hashtable();
StringBuffer sb=new StringBuffer();
PrintWriter mod_jk = new PrintWriter(new FileWriter(jkConfig));
log("Generating apache mod_jk config = "+jkConfig );
generateJkHead( mod_jk );
// XXX Make those options configurable in server.xml
generateSSLConfig( mod_jk );
Hashtable vhosts = new Hashtable();
// Set up contexts
// XXX deal with Virtual host configuration !!!!
Enumeration enum = cm.getContexts();
while (enum.hasMoreElements()) {
Context context = (Context)enum.nextElement();
String host = context.getHost();
if( host == null ) {
if( forwardAll )
generateStupidMappings( context, mod_jk );
else
generateContextMappings( context, mod_jk );
} else {
Vector vhostContexts = (Vector)vhosts.get(host);
if ( vhostContexts == null ) {
vhostContexts = new Vector();
vhosts.put(host,vhostContexts);
}
vhostContexts.addElement(context);
}
}
enum = vhosts.elements();
while( enum.hasMoreElements() ) {
Vector vhostContexts = (Vector)enum.nextElement();
for( int i = 0; i < vhostContexts.size(); i++ ) {
Context context = (Context)vhostContexts.elementAt(i);
if( i == 0 )
generateVhostHead( context, mod_jk );
if( forwardAll )
generateStupidMappings( context, mod_jk );
else
generateContextMappings( context, mod_jk );
}
generateVhostTail( mod_jk );
}
mod_jk.close();
} catch( Exception ex ) {
Log loghelper = Log.getLog("tc_log", this);
loghelper.log("Error generating automatic apache configuration",
ex);
}
}//end execute()
// -------------------- Config sections --------------------
/** Generate the loadModule and general options
*/
private boolean generateJkHead(PrintWriter mod_jk)
throws TomcatException
{
mod_jk.println("########## Auto generated on " + new Date() +
"##########" );
mod_jk.println();
// Fail if mod_jk not found, let the user know the problem
// instead of running into problems later.
if( ! modJk.exists() ) {
log( "mod_jk location: " + modJk );
log( "Make sure it is installed corectly or " +
" set the config location" );
log( "Using <ApacheConfig modJk=\"PATH_TO_MOD_JK.SO_OR_DLL\" />" );
//throw new TomcatException( "mod_jk not found ");
}
// Verify the file exists !!
mod_jk.println("<IfModule !mod_jk.c>");
mod_jk.println(" LoadModule jk_module "+
modJk.toString().replace('\\','/'));
mod_jk.println("</IfModule>");
mod_jk.println();
// Fail if workers file not found, let the user know the problem
// instead of running into problems later.
if( ! workersConfig.exists() ) {
log( "Can't find workers.properties at " + workersConfig );
log( "Please install it in the default location or " +
" set the config location" );
log( "Using <ApacheConfig workersConfig=\"FULL_PATH\" />" );
throw new TomcatException( "workers.properties not found ");
}
mod_jk.println("JkWorkersFile \""
+ workersConfig.toString().replace('\\', '/')
+ "\"");
mod_jk.println("JkLogFile \""
+ jkLog.toString().replace('\\', '/')
+ "\"");
mod_jk.println();
if( jkDebug != null ) {
mod_jk.println("JkLogLevel " + jkDebug);
mod_jk.println();
}
return true;
}
private void generateVhostHead(Context context, PrintWriter mod_jk) {
String ctxPath = context.getPath();
String vhost = context.getHost();
mod_jk.println();
String vhostip = getVirtualHostAddress(vhost,
context.getHostAddress());
generateNameVirtualHost(mod_jk, vhostip);
mod_jk.println("<VirtualHost "+ vhostip + ">");
mod_jk.println(" ServerName " + vhost );
Enumeration aliases=context.getHostAliases();
if( aliases.hasMoreElements() ) {
mod_jk.print(" ServerAlias " );
while( aliases.hasMoreElements() ) {
mod_jk.print( (String)aliases.nextElement() + " " );
}
mod_jk.println();
}
indent=" ";
}
private void generateVhostTail(PrintWriter mod_jk) {
mod_jk.println("</VirtualHost>");
indent="";
}
private void generateSSLConfig(PrintWriter mod_jk) {
if( ! sslExtract ) {
mod_jk.println("JkExtractSSL Off");
}
if( ! "HTTPS".equalsIgnoreCase( sslHttpsIndicator ) ) {
mod_jk.println("JkHTTPSIndicator " + sslHttpsIndicator);
}
if( ! "SSL_SESSION_ID".equalsIgnoreCase( sslSessionIndicator )) {
mod_jk.println("JkSESSIONIndicator " + sslSessionIndicator);
}
if( ! "SSL_CIPHER".equalsIgnoreCase( sslCipherIndicator )) {
mod_jk.println("JkCIPHERIndicator " + sslCipherIndicator);
}
if( ! "SSL_CLIENT_CERT".equalsIgnoreCase( sslCertsIndicator )) {
mod_jk.println("JkCERTSIndicator " + sslCertsIndicator);
}
mod_jk.println();
}
// -------------------- Forward all mode --------------------
String indent="";
/** Forward all requests for a context to tomcat.
The default.
*/
private void generateStupidMappings(Context context,
PrintWriter mod_jk )
{
String ctxPath = context.getPath();
String vhost = context.getHost();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in forward-all mode ");
return;
}
mod_jk.println();
mod_jk.println(indent + "JkMount " + nPath + " " + jkWorker );
if( "".equals(ctxPath) ) {
mod_jk.println(indent + "JkMount " + nPath + "* " + jkWorker );
if ( vhost != null ) {
mod_jk.println(indent + "DocumentRoot \"" +
getApacheDocBase(context) + "\"");
} else {
mod_jk.println(indent +
"# To avoid Apache serving root welcome files from htdocs, update DocumentRoot");
mod_jk.println(indent +
"# to point to: \"" + getApacheDocBase(context) + "\"");
}
} else
mod_jk.println(indent + "JkMount " + nPath + "/* " + jkWorker );
}
private void generateNameVirtualHost( PrintWriter mod_jk, String ip ) {
if( !NamedVirtualHosts.containsKey(ip) ) {
mod_jk.println("NameVirtualHost " + ip + "");
NamedVirtualHosts.put(ip,ip);
}
}
// -------------------- Apache serves static mode --------------------
// This is not going to work for all apps. We fall back to stupid mode.
private void generateContextMappings(Context context, PrintWriter mod_jk )
{
String ctxPath = context.getPath();
String vhost = context.getHost();
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in non-forward-all mode ");
return;
}
mod_jk.println();
mod_jk.println(indent + "#################### " +
((vhost!=null ) ? vhost + ":" : "" ) +
(("".equals(ctxPath)) ? "/" : ctxPath ) +
" ####################" );
mod_jk.println();
// Dynamic /servet pages go to Tomcat
generateStaticMappings( context, mod_jk );
// InvokerInterceptor - it doesn't have a container,
// but it's implemented using a special module.
// XXX we need to better collect all mappings
addMapping( ctxPath + "/servlet/*", mod_jk );
Enumeration servletMaps=context.getContainers();
while( servletMaps.hasMoreElements() ) {
Container ct=(Container)servletMaps.nextElement();
addMapping( context, ct , mod_jk );
}
// There is a big problem with this one - it is
// equivalent with JkMount path/*...
// The good news - there is a container with exactly this
// map ( the real path that is used by form auth ), so no need
// for this one
//mod_jk.println("JkMount " + path + "/*j_security_check " +
// jkWorker);
//mod_jk.println();
// XXX ErrorDocument
// Security and filter mappings
}
/** Add an Apache extension mapping.
*/
protected boolean addExtensionMapping( String ctxPath, String ext,
PrintWriter mod_jk )
{
if( debug > 0 )
log( "Adding extension map for " + ctxPath + "/*." + ext );
mod_jk.println(indent + "JkMount " + ctxPath + "/*." + ext
+ " " + jkWorker);
return true;
}
/** Add a fulling specified Appache mapping.
*/
protected boolean addMapping( String fullPath, PrintWriter mod_jk ) {
if( debug > 0 )
log( "Adding map for " + fullPath );
if( fullPath.endsWith("/*") ) {
mod_jk.println(indent + "JkMount "
+ fullPath.substring(0, fullPath.length() - 2)
+ " " + jkWorker );
}
mod_jk.println(indent + "JkMount " + fullPath + " " + jkWorker );
return true;
}
private void generateWelcomeFiles(Context context, PrintWriter mod_jk ) {
String wf[]=context.getWelcomeFiles();
if( wf==null || wf.length == 0 )
return;
mod_jk.print(indent + " DirectoryIndex ");
for( int i=0; i<wf.length ; i++ ) {
mod_jk.print( wf[i] + " " );
}
mod_jk.println();
}
/** Mappings for static content. XXX need to add welcome files,
* mime mappings ( all will be handled by Mime and Static modules of
* apache ).
*/
private void generateStaticMappings(Context context, PrintWriter mod_jk ) {
String ctxPath = context.getPath();
// Calculate the absolute path of the document base
String docBase = getApacheDocBase(context);
if( !"".equals(ctxPath) ) {
// Static files will be served by Apache
mod_jk.println(indent + "# Static files ");
mod_jk.println(indent + "Alias " + ctxPath + " \"" + docBase + "\"");
mod_jk.println();
} else {
if ( context.getHost() != null ) {
mod_jk.println(indent + "DocumentRoot \"" +
getApacheDocBase(context) + "\"");
} else {
// For root context, ask user to update DocumentRoot setting.
// Using "Alias / " interferes with the Alias for other contexts.
mod_jk.println(indent +
"# Be sure to update DocumentRoot");
mod_jk.println(indent +
"# to point to: \"" + docBase + "\"");
}
}
mod_jk.println(indent + "<Directory \"" + docBase + "\">");
mod_jk.println(indent + " Options Indexes FollowSymLinks");
generateWelcomeFiles(context, mod_jk);
// XXX XXX Here goes the Mime types and welcome files !!!!!!!!
mod_jk.println(indent + "</Directory>");
mod_jk.println();
// Deny serving any files from WEB-INF
mod_jk.println();
mod_jk.println(indent +
"# Deny direct access to WEB-INF and META-INF");
mod_jk.println(indent + "#");
mod_jk.println(indent + "<Location \"" + ctxPath + "/WEB-INF/*\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Location>");
// Deny serving any files from META-INF
mod_jk.println();
mod_jk.println(indent + "<Location \"" + ctxPath + "/META-INF/*\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Location>");
if (File.separatorChar == '\\') {
mod_jk.println(indent + "#");
mod_jk.println(indent +
"# Use Directory too. On Windows, Location doesn't"
+ " work unless case matches");
mod_jk.println(indent + "#");
mod_jk.println(indent +
"<Directory \"" + docBase + "/WEB-INF/\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Directory>");
mod_jk.println();
mod_jk.println(indent +
"<Directory \"" + docBase + "/META-INF/\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Directory>");
}
mod_jk.println();
}
// -------------------- Utils --------------------
private String getApacheDocBase(Context context)
{
// Calculate the absolute path of the document base
String docBase = getAbsoluteDocBase(context);
if (File.separatorChar == '\\') {
// use separator preferred by Apache
docBase = docBase.replace('\\','/');
}
return docBase;
}
private String getVirtualHostAddress(String vhost, String vhostip) {
if( vhostip == null ) {
if ( vhost != null && vhost.length() > 0 && Character.isDigit(vhost.charAt(0)) )
vhostip=vhost;
else
vhostip="*";
}
return vhostip;
}
}
1.1 jakarta-tomcat-connectors/jk/java/org/apache/jk/server/tomcat33/config/BaseJkConfig.java
Index: BaseJkConfig.java
===================================================================
/* $Id: BaseJkConfig.java,v 1.1 2002/02/20 23:45:03 costin Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.jk.server.tomcat33.config;
import org.apache.tomcat.core.*;
import org.apache.tomcat.util.io.FileUtil;
import java.io.*;
import org.apache.tomcat.modules.server.Ajp13Interceptor;
/**
Base class for automatic jk based configurations based on
the Tomcat server.xml settings and the war contexts
initialized during startup.
<p>
This config interceptor is enabled by inserting a Config
element in the <b><ContextManager></b> tag body inside
the server.xml file like so:
<pre>
* < ContextManager ... >
* ...
* <<b>???Config</b> <i>options</i> />
* ...
* < /ContextManager >
</pre>
where <i>options</i> can include any of the following attributes:
<ul>
<li><b>configHome</b> - default parent directory for the following paths.
If not set, this defaults to TOMCAT_HOME. Ignored
whenever any of the following paths is absolute.
</li>
<li><b>workersConfig</b> - path to workers.properties file used by
jk connector. If not set, defaults to
"conf/jk/workers.properties".</li>
<li><b>jkLog</b> - path to log file to be used by jk connector.</li>
<li><b>jkDebug</b> - Loglevel setting. May be debug, info, error, or emerg.
If not set, defaults to emerg.</li>
<li><b>jkWorker</b> The desired worker. Must be set to one of the workers
defined in the workers.properties file. "ajp12", "ajp13"
or "inprocess" are the workers found in the default
workers.properties file. If not specified, defaults
to "ajp13" if an Ajp13Interceptor is in use, otherwise
it defaults to "ajp12".</li>
<li><b>forwardAll</b> - If true, forward all requests to Tomcat. This helps
insure that all the behavior configured in the web.xml
file functions correctly. If false, let Apache serve
static resources. The default is true.
Warning: When false, some configuration in
the web.xml may not be duplicated in Apache.
Review the mod_jk conf file to see what
configuration is actually being set in Apache.</li>
<li><b>noRoot</b> - If true, the root context is not mapped to
Tomcat. If false and forwardAll is true, all requests
to the root context are mapped to Tomcat. If false and
forwardAll is false, only JSP and servlets requests to
the root context are mapped to Tomcat. When false,
to correctly serve Tomcat's root context you may also
need to modify the web server to point it's home
directory to Tomcat's root context directory.
Otherwise some content, such as the root index.html,
may be served by the web server before the connector
gets a chance to claim the request and pass it to Tomcat.
The default is true.</li>
</ul>
<p>
@author Costin Manolache
@author Larry Isaacs
@version $Revision: 1.1 $
*/
public class BaseJkConfig extends BaseInterceptor {
protected File configHome = null;
protected File workersConfig = null;
protected File jkLog = null;
protected String jkDebug="emerg";
protected String jkWorker = null;
protected boolean noRoot=true;
protected boolean forwardAll=true;
protected String tomcatHome;
protected boolean regenerate=false;
// -------------------- Tomcat callbacks --------------------
public void addInterceptor( ContextManager cm,
Context ctx,
BaseInterceptor bi )
throws TomcatException
{
if( cm.getProperty( "jkconf" ) != null ) {
// we are in config generation mode - prevent tomcat
// from starting.
//??? cm.setNote("nostart", this );
}
}
// Auto-config should be able to react to dynamic config changes,
// and regenerate the config.
/** Generate the configuration - only when the server is
* completely initialized ( before starting )
*/
public void engineState( ContextManager cm, int state )
throws TomcatException
{
if( state != ContextManager.STATE_INIT )
return;
// Generate the config only if "regenerate" property is
// set on the module or if an explicit "jkconf" option has
// been set on context manager.
if( regenerate ||
cm.getProperty("jkconf") !=null) {
execute( cm );
}
}
public void contextInit(Context ctx)
throws TomcatException
{
ContextManager cm=ctx.getContextManager();
if( cm.getState() >= ContextManager.STATE_INIT ) {
// a context has been added after the server was started.
// regenerate the config ( XXX send a restart signal to
// the server )
// Generate the config only if "regenerate" property is
// set on the module or if an explicit "jkconf" option has
// been set on context manager.
if( regenerate ||
cm.getProperty("jkconf") !=null) {
execute( cm );
}
}
}
/** Generate configuration files. Override with method to generate
web server specific configuration.
*/
public void execute(ContextManager cm) throws TomcatException
{
}
//-------------------- Properties --------------------
/** If false, we'll try to generate a config that will
* let apache serve static files.
* The default is true, forward all requests in a context
* to tomcat.
*/
public void setForwardAll( boolean b ) {
forwardAll=b;
}
/** Special option - do not generate mappings for the ROOT
context. The default is true, and will not generate the mappings,
not redirecting all pages to tomcat (since /* matches everything).
This means that the web server's root remains intact but isn't
completely servlet/JSP enabled. If the ROOT webapp can be configured
with the web server serving static files, there's no problem setting
this option to false. If not, then setting it true means the web
server will be out of picture for all requests.
*/
public void setNoRoot( boolean b ) {
noRoot=b;
}
/**
set a path to the parent directory of the
conf folder. That is, the parent directory
within which path setters would be resolved against,
if relative. For example if ConfigHome is set to "/home/tomcat"
and regConfig is set to "conf/mod_jk.conf" then the resulting
path used would be:
"/home/tomcat/conf/mod_jk.conf".</p>
<p>
However, if the path is set to an absolute path,
this attribute is ignored.
<p>
If not set, execute() will set this to TOMCAT_HOME.
<p>
@param <b>dir</b> - path to a directory
*/
public void setConfigHome(String dir){
if( dir==null ) return;
File f=new File(dir);
if(!f.isDirectory()){
throw new IllegalArgumentException(
"BaseConfig.setConfigHome(): "+
"Configuration Home must be a directory! : "+dir);
}
configHome = f;
}
/**
set a path to the workers.properties file.
@param <b>path</b> String path to workers.properties file
*/
public void setWorkersConfig(String path){
workersConfig= (path==null?null:new File(path));
}
/**
set the path to the log file
@param <b>path</b> String path to a file
*/
public void setJkLog(String path){
jkLog= ( path==null?null:new File(path));
}
/** Set the verbosity level
( use debug, error, etc. ) If not set, no log is written.
*/
public void setJkDebug( String level ) {
jkDebug=level;
}
/**
set the Ajp protocal
@param <b>protocal</b> String protocol, "ajp12" or "ajp13"
*/
public void setJkWorker(String worker){
jkWorker = worker;
}
// -------------------- Initialize/guess defaults --------------------
/** Initialize defaults for properties that are not set
explicitely
*/
protected void initProperties(ContextManager cm) {
tomcatHome = cm.getHome();
File tomcatDir = new File(tomcatHome);
if(configHome==null){
configHome=tomcatDir;
}
}
protected void initWorker(ContextManager cm) {
// Find Ajp1? connectors
BaseInterceptor ci[]=cm.getContainer().getInterceptors();
for( int i=0; i<ci.length; i++ ) {
Object con=ci[i];
// if jkWorker not specified and Ajp13 Interceptor found, use Ajp13
if( jkWorker == null && (con instanceof Ajp13Interceptor) ) {
jkWorker = "ajp13";
}
}
// default to ajp12
if( jkWorker==null ) jkWorker="ajp12";
}
// -------------------- Config Utils --------------------
protected boolean addMapping( Context ctx, Container ct,
PrintWriter pw )
{
int type=ct.getMapType();
String ctPath=ct.getPath();
String ctxPath=ctx.getPath();
if( type==Container.EXTENSION_MAP ) {
if( ctPath.length() < 3 ) return false;
String ext=ctPath.substring( 2 );
return addExtensionMapping( ctxPath, ext , pw );
}
String fullPath=null;
if( ctPath.startsWith("/" ))
fullPath=ctxPath+ ctPath;
else
fullPath=ctxPath + "/" + ctPath;
return addMapping( fullPath, pw);
}
/** Add an extension mapping. Override with method to generate
web server specific configuration
*/
protected boolean addExtensionMapping( String ctxPath, String ext,
PrintWriter pw )
{
return true;
}
/** Add a fulling specified mapping. Override with method to generate
web server specific configuration
*/
protected boolean addMapping( String fullPath, PrintWriter pw ) {
return true;
}
// -------------------- General Utils --------------------
protected String getAbsoluteDocBase(Context context)
{
// Calculate the absolute path of the document base
String docBase = context.getDocBase();
if (!FileUtil.isAbsolute(docBase)){
docBase = tomcatHome + "/" + docBase;
}
docBase = FileUtil.patch(docBase);
return docBase;
}
}
1.1 jakarta-tomcat-connectors/jk/java/org/apache/jk/server/tomcat33/config/IISConfig.java
Index: IISConfig.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.jk.server.tomcat33.config;
import org.apache.tomcat.core.*;
import org.apache.tomcat.util.io.FileUtil;
//import org.apache.tomcat.util.*;
import org.apache.tomcat.util.log.*;
import java.io.*;
import java.util.*;
/**
Generates automatic IIS isapi_redirect configurations based on
the Tomcat server.xml settings and the war contexts
initialized during startup.
<p>
This config interceptor is enabled by inserting an IISConfig
element in the <b><ContextManager></b> tag body inside
the server.xml file like so:
<pre>
* < ContextManager ... >
* ...
* <<b>IISConfig</b> <i>options</i> />
* ...
* < /ContextManager >
</pre>
where <i>options</i> can include any of the following attributes:
<ul>
<li><b>configHome</b> - default parent directory for the following paths.
If not set, this defaults to TOMCAT_HOME. Ignored
whenever any of the following paths is absolute.
</li>
<li><b>regConfig</b> - path to use for writing IIS isapi_redirect registry
file. If not set, defaults to
"conf/auto/iis_redirect.reg".</li>
<li><b>workersConfig</b> - path to workers.properties file used by
isapi_redirect. If not set, defaults to
"conf/jk/workers.properties".</li>
<li><b>uriConfig</b> - path to use for writing IIS isapi_redirect uriworkermap
file. If not set, defaults to
"conf/auto/uriworkermap.properties".</li>
<li><b>jkLog</b> - path to log file to be used by isapi_redirect.</li>
<li><b>jkDebug</b> - Loglevel setting. May be debug, info, error, or emerg.
If not set, defaults to emerg.</li>
<li><b>jkWorker</b> The desired worker. Must be set to one of the workers
defined in the workers.properties file. "ajp12", "ajp13"
or "inprocess" are the workers found in the default
workers.properties file. If not specified, defaults
to "ajp13" if an Ajp13Interceptor is in use, otherwise
it defaults to "ajp12".</li>
<li><b>forwardAll</b> - If true, forward all requests to Tomcat. This helps
insure that all the behavior configured in the web.xml
file functions correctly. If false, let IIS serve
static resources assuming it has been configured
to do so. The default is true.
Warning: When false, some configuration in
the web.xml may not be duplicated in IIS.
Review the uriworkermap file to see what
configuration is actually being set in IIS.</li>
<li><b>noRoot</b> - If true, the root context is not mapped to
Tomcat. If false and forwardAll is true, all requests
to the root context are mapped to Tomcat. If false and
forwardAll is false, only JSP and servlets requests to
the root context are mapped to Tomcat. When false,
to correctly serve Tomcat's root context you must also
modify the Home Directory setting in IIS
to point to Tomcat's root context directory.
Otherwise some content, such as the root index.html,
will be served by IIS before isapi_redirect gets a chance
to claim the request and pass it to Tomcat.
The default is true.</li>
</ul>
<p>
@author Costin Manolache
@author Larry Isaacs
@author Gal Shachor
@version $Revision: 1.1 $
*/
public class IISConfig extends BaseJkConfig {
public static final String WORKERS_CONFIG = "conf/jk/workers.properties";
public static final String URI_WORKERS_MAP_CONFIG = "conf/auto/uriworkermap.properties";
public static final String ISAPI_LOG_LOCATION = "logs/iis_redirect.log";
public static final String ISAPI_REG_FILE = "conf/auto/iis_redirect.reg";
public static final String ISAPI_PROP_FILE = "conf/auto/isapi_redirect.properties";
public static final String ISAPI_REDIRECTOR = "isapi_redirect.dll";
private File regConfig = null;
private File propConfig = null;
private File uriConfig = null;
private String isapiRedirector = null;
public IISConfig()
{
}
//-------------------- Properties --------------------
private void updatePropFile() {
propConfig=null;
if( isapiRedirector != null ) {
int idx=isapiRedirector.lastIndexOf('.');
if( idx > 0 ) {
String dir=(regConfig!=null) ?
regConfig.toString().replace(File.separatorChar,'/') :
ISAPI_REG_FILE;
int idx2=dir.lastIndexOf('/');
if( idx2 > 0 ) {
dir = dir.substring(0,idx2 + 1);
} else {
dir = "";
}
propConfig = new File(dir + isapiRedirector.substring(0,idx)
+ ".properties");
}
}
}
/**
set the path to the output file for the auto-generated
isapi_redirect registry file. If this path is relative
then getRegConfig() will resolve it absolutely against
the getConfigHome() path.
<p>
@param <b>path</b> String path to a file
*/
public void setRegConfig(String path){
regConfig= (path==null)?null:new File(path);
updatePropFile();
}
/**
set a path to the uriworkermap.properties file.
@param <b>path</b> String path to uriworkermap.properties file
*/
public void setUriConfig(String path){
uriConfig= (path==null?null:new File(path));
}
public void setIsapiRedirector(String s) {
isapiRedirector=s;
updatePropFile();
}
// -------------------- Initialize/guess defaults --------------------
/** Initialize defaults for properties that are not set
explicitely
*/
protected void initProperties(ContextManager cm) {
super.initProperties(cm);
regConfig=FileUtil.getConfigFile( regConfig, configHome, ISAPI_REG_FILE);
propConfig=FileUtil.getConfigFile( propConfig, configHome, ISAPI_PROP_FILE);
workersConfig=FileUtil.getConfigFile( workersConfig, configHome, WORKERS_CONFIG);
uriConfig=FileUtil.getConfigFile( uriConfig, configHome, URI_WORKERS_MAP_CONFIG);
jkLog=FileUtil.getConfigFile( jkLog, configHome, ISAPI_LOG_LOCATION);
}
// -------------------- Generate config --------------------
/**
executes the IISConfig interceptor. This method generates IIS
configuration files for use with isapi_redirect. If not
already set, this method will setConfigHome() to the value returned
from <i>cm.getHome()</i>.
<p>
@param <b>cm</b> a ContextManager object.
*/
public void execute(ContextManager cm) throws TomcatException
{
try {
initProperties(cm);
initWorker(cm);
PrintWriter regfile = new PrintWriter(new FileWriter(regConfig));
PrintWriter propfile = new PrintWriter(new FileWriter(propConfig));
PrintWriter uri_worker = new PrintWriter(new FileWriter(uriConfig));
log("Generating IIS registry file = "+regConfig );
log("Generating IIS properties file = "+propConfig );
log("Generating IIS URI worker map file = "+uriConfig );
generateRegistrySettings(regfile);
generatePropertySettings(propfile);
generateUriWorkerHeader(uri_worker);
// Set up contexts
// XXX deal with Virtual host configuration !!!!
Enumeration enum = cm.getContexts();
while (enum.hasMoreElements()) {
Context context = (Context)enum.nextElement();
String vhost = context.getHost();
if(vhost != null) {
// Vhosts are not supported yet for IIS
continue;
}
if( forwardAll )
generateStupidMappings( context, uri_worker );
else
generateContextMappings( context, uri_worker );
}
regfile.close();
propfile.close();
uri_worker.close();
} catch(Exception ex) {
Log loghelper = Log.getLog("tc_log", this);
loghelper.log("Error generating automatic IIS configuration", ex);
}
}
// -------------------- Config sections --------------------
/** Writes the registry settings required by the IIS connector
*/
private void generateRegistrySettings(PrintWriter regfile)
{
regfile.println("REGEDIT4");
regfile.println();
regfile.println("[HKEY_LOCAL_MACHINE\\SOFTWARE\\Apache Software Foundation\\Jakarta Isapi Redirector\\1.0]");
regfile.println("\"extension_uri\"=\"/jakarta/"
+ (isapiRedirector!=null?isapiRedirector:ISAPI_REDIRECTOR) + "\"");
regfile.println("\"log_file\"=\"" + dubleSlash(jkLog.toString()) +"\"");
regfile.println("\"log_level\"=\"" + jkDebug + "\"");
regfile.println("\"worker_file\"=\"" + dubleSlash(workersConfig.toString()) +"\"");
regfile.println("\"worker_mount_file\"=\"" + dubleSlash(uriConfig.toString()) +"\"");
regfile.println("\"uri_select\"=\"parsed\"");
}
/** Writes the registry settings required by the IIS connector
*/
private void generatePropertySettings(PrintWriter propfile)
{
propfile.println("extension_uri=/jakarta/"
+ (isapiRedirector!=null?isapiRedirector:ISAPI_REDIRECTOR));
propfile.println("log_file=" + jkLog.toString());
propfile.println("log_level=" + jkDebug);
propfile.println("worker_file=" + workersConfig.toString());
propfile.println("worker_mount_file=" + uriConfig.toString());
propfile.println("uri_select=parsed");
}
/** Writes the header information to the uriworkermap file
*/
private void generateUriWorkerHeader(PrintWriter uri_worker)
{
uri_worker.println("###################################################################");
uri_worker.println("# Auto generated configuration. Dated: " + new Date());
uri_worker.println("###################################################################");
uri_worker.println();
uri_worker.println("#");
uri_worker.println("# Default worker to be used through our mappings");
uri_worker.println("#");
uri_worker.println("default.worker=" + jkWorker);
uri_worker.println();
}
/** Forward all requests for a context to tomcat.
The default.
*/
private void generateStupidMappings(Context context, PrintWriter uri_worker )
{
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in forward-all mode ");
return;
}
// map all requests for this context to Tomcat
uri_worker.println(nPath +"=$(default.worker)");
if( "".equals(ctxPath) ) {
uri_worker.println(nPath +"*=$(default.worker)");
uri_worker.println(
"# Note: To correctly serve the Tomcat's root context, IIS's Home Directory must");
uri_worker.println(
"# must be set to: \"" + getAbsoluteDocBase(context) + "\"");
}
else
uri_worker.println(nPath +"/*=$(default.worker)");
}
private void generateContextMappings(Context context, PrintWriter uri_worker )
{
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in forward-all mode ");
return;
}
// Static files will be served by IIS
uri_worker.println();
uri_worker.println("#########################################################");
uri_worker.println("# Auto configuration for the " + nPath + " context.");
uri_worker.println("#########################################################");
uri_worker.println();
// Static mappings are not set in uriworkermap, but must be set with IIS admin.
// InvokerInterceptor - it doesn't have a container,
// but it's implemented using a special module.
// XXX we need to better collect all mappings
addMapping( ctxPath + "/servlet/*", uri_worker );
Enumeration servletMaps=context.getContainers();
while( servletMaps.hasMoreElements() ) {
Container ct=(Container)servletMaps.nextElement();
addMapping( context, ct , uri_worker );
}
// XXX ErrorDocument
// Security and filter mappings
}
/** Add an IIS extension mapping.
*/
protected boolean addExtensionMapping( String ctxPath, String ext,
PrintWriter uri_worker )
{
if( debug > 0 )
log( "Adding extension map for " + ctxPath + "/*." + ext );
uri_worker.println(ctxPath + "/*." + ext + "=$(default.worker)");
return true;
}
/** Add a fulling specified IIS mapping.
*/
protected boolean addMapping( String fullPath, PrintWriter uri_worker ) {
if( debug > 0 )
log( "Adding map for " + fullPath );
if( fullPath.endsWith("/*") ) {
uri_worker.println(fullPath.substring(0, fullPath.length() - 2)
+ "=$(default.worker)" );
}
uri_worker.println(fullPath + "=$(default.worker)" );
return true;
}
// -------------------- Utils --------------------
private String dubleSlash(String in)
{
StringBuffer sb = new StringBuffer();
for(int i = 0 ; i < in.length() ; i++) {
char ch = in.charAt(i);
if('\\' == ch) {
sb.append("\\\\");
} else {
sb.append(ch);
}
}
return sb.toString();
}
}
1.1 jakarta-tomcat-connectors/jk/java/org/apache/jk/server/tomcat33/config/NSConfig.java
Index: NSConfig.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.jk.server.tomcat33.config;
import org.apache.tomcat.core.*;
import org.apache.tomcat.util.io.FileUtil;
import org.apache.tomcat.util.log.*;
import java.io.*;
import java.util.*;
/**
Generates automatic Netscape nsapi_redirect configurations based on
the Tomcat server.xml settings and the war contexts
initialized during startup.
<p>
This config interceptor is enabled by inserting an NSConfig
element in the <b><ContextManager></b> tag body inside
the server.xml file like so:
<pre>
* < ContextManager ... >
* ...
* <<b>NSConfig</b> <i>options</i> />
* ...
* < /ContextManager >
</pre>
where <i>options</i> can include any of the following attributes:
<ul>
<li><b>configHome</b> - default parent directory for the following paths.
If not set, this defaults to TOMCAT_HOME. Ignored
whenever any of the following paths is absolute.
</li>
<li><b>objConfig</b> - path to use for writing Netscape obj.conf
file. If not set, defaults to
"conf/auto/obj.conf".</li>
<li><b>objectName</b> - Name of the Object to execute the requests.
Defaults to "servlet".</li>
<li><b>workersConfig</b> - path to workers.properties file used by
nsapi_redirect. If not set, defaults to
"conf/jk/workers.properties".</li>
<li><b>nsapiJk</b> - path to Netscape mod_jk plugin file. If not set,
defaults to "bin/nsapi_redirect.dll" on windows,
"bin/nsapi_rd.nlm" on netware, and
"bin/nsapi_redirector.so" everywhere else.</li>
<li><b>jkLog</b> - path to log file to be used by nsapi_redirect.</li>
<li><b>jkDebug</b> - Loglevel setting. May be debug, info, error, or emerg.
If not set, defaults to emerg.</li>
<li><b>jkWorker</b> The desired worker. Must be set to one of the workers
defined in the workers.properties file. "ajp12", "ajp13"
or "inprocess" are the workers found in the default
workers.properties file. If not specified, defaults
to "ajp13" if an Ajp13Interceptor is in use, otherwise
it defaults to "ajp12".</li>
<li><b>forwardAll</b> - If true, forward all requests to Tomcat. This helps
insure that all the behavior configured in the web.xml
file functions correctly. If false, let Netscape serve
static resources assuming it has been configured
to do so. The default is true.
Warning: When false, some configuration in
the web.xml may not be duplicated in Netscape.
Review the uriworkermap file to see what
configuration is actually being set in Netscape.</li>
<li><b>noRoot</b> - If true, the root context is not mapped to
Tomcat. If false and forwardAll is true, all requests
to the root context are mapped to Tomcat. If false and
forwardAll is false, only JSP and servlets requests to
the root context are mapped to Tomcat. When false,
to correctly serve Tomcat's root context you must also
modify the Home Directory setting in Netscape
to point to Tomcat's root context directory.
Otherwise some content, such as the root index.html,
will be served by Netscape before nsapi_redirect gets a chance
to claim the request and pass it to Tomcat.
The default is true.</li>
</ul>
<p>
@author Costin Manolache
@author Larry Isaacs
@author Gal Shachor
@version $Revision: 1.1 $
*/
public class NSConfig extends BaseJkConfig {
public static final String WORKERS_CONFIG = "conf/jk/workers.properties";
public static final String NS_CONFIG = "conf/auto/obj.conf";
public static final String NSAPI_LOG_LOCATION = "logs/nsapi_redirect.log";
/** default location of nsapi plug-in. */
public static String NSAPI_REDIRECTOR;
//set up some defaults based on OS type
static{
String os = System.getProperty("os.name").toLowerCase();
if(os.indexOf("windows")>=0){
NSAPI_REDIRECTOR = "bin/nsapi_redirect.dll";
}else if(os.indexOf("netware")>=0){
NSAPI_REDIRECTOR = "bin/nsapi_rd.nlm";
}else{
NSAPI_REDIRECTOR = "bin/nsapi_redirector.so";
}
}
private File objConfig = null;
private File nsapiJk = null;
private String objectName = "servlet";
Log loghelper = Log.getLog("tc_log", this);
public NSConfig()
{
}
//-------------------- Properties --------------------
/**
set the path to the output file for the auto-generated
isapi_redirect registry file. If this path is relative
then getRegConfig() will resolve it absolutely against
the getConfigHome() path.
<p>
@param <b>path</b> String path to a file
*/
public void setObjConfig(String path) {
objConfig= (path==null)?null:new File(path);
}
/**
set the path to the nsapi plugin module
@param <b>path</b> String path to a file
*/
public void setNsapiJk(String path) {
nsapiJk=( path==null?null:new File(path));
}
/**
Set the name for the Object that implements the
jk_service call.
@param <b>name</b> Name of the obj.conf Object
*/
public void setObjectName(String name) {
objectName = name;
}
// -------------------- Initialize/guess defaults --------------------
/** Initialize defaults for properties that are not set
explicitely
*/
protected void initProperties(ContextManager cm) {
super.initProperties(cm);
objConfig=FileUtil.getConfigFile( objConfig, configHome, NS_CONFIG);
workersConfig=FileUtil.getConfigFile( workersConfig, configHome, WORKERS_CONFIG);
if( nsapiJk == null )
nsapiJk=new File(NSAPI_REDIRECTOR);
else
nsapiJk =FileUtil.getConfigFile( nsapiJk, configHome, NSAPI_REDIRECTOR );
jkLog=FileUtil.getConfigFile( jkLog, configHome, NSAPI_LOG_LOCATION);
}
// -------------------- Generate config --------------------
/**
executes the NSConfig interceptor. This method generates Netscape
configuration files for use with nsapi_redirect. If not
already set, this method will setConfigHome() to the value returned
from <i>cm.getHome()</i>.
<p>
@param <b>cm</b> a ContextManager object.
*/
public void execute(ContextManager cm) throws TomcatException
{
try {
initProperties(cm);
initWorker(cm);
PrintWriter objfile = new PrintWriter(new FileWriter(objConfig));
log("Generating netscape web server config = "+objConfig );
generateNsapiHead( objfile );
objfile.println("<Object name=default>");
// Set up contexts
// XXX deal with Virtual host configuration !!!!
Enumeration enum = cm.getContexts();
while (enum.hasMoreElements()) {
Context context = (Context)enum.nextElement();
String vhost = context.getHost();
if(vhost != null) {
// Vhosts are not supported yet for Netscape
continue;
}
if( forwardAll )
generateStupidMappings( context, objfile );
else
generateContextMappings( context, objfile );
}
generateNsapiTail(objfile);
objfile.close();
} catch(Exception ex) {
loghelper.log("Error generating automatic Netscape configuration", ex);
}
}
private void generateNsapiHead(PrintWriter objfile)
throws TomcatException
{
objfile.println("###################################################################");
objfile.println("# Auto generated configuration. Dated: " + new Date());
objfile.println("###################################################################");
objfile.println();
objfile.println("#");
objfile.println("# You will need to merge the content of this file with your ");
objfile.println("# regular obj.conf and then restart (=stop + start) your Netscape server. ");
objfile.println("#");
objfile.println();
objfile.println("#");
objfile.println("# Loading the redirector into your server");
objfile.println("#");
objfile.println();
objfile.println("Init fn=\"load-modules\" funcs=\"jk_init,jk_service\" shlib=\"<put full path to the redirector here>\"");
objfile.println("Init fn=\"jk_init\" worker_file=\"" +
workersConfig.toString().replace('\\', '/') +
"\" log_level=\"" + jkDebug + "\" log_file=\"" +
jkLog.toString().replace('\\', '/') +
"\"");
objfile.println();
}
private void generateNsapiTail(PrintWriter objfile)
throws TomcatException
{
objfile.println();
objfile.println("#######################################################");
objfile.println("# Protecting the WEB-INF and META-INF directories.");
objfile.println("#######################################################");
objfile.println("PathCheck fn=\"deny-existence\" path=\"*/WEB-INF\"");
objfile.println("PathCheck fn=\"deny-existence\" path=\"*/WEB-INF/*\"");
objfile.println("PathCheck fn=\"deny-existence\" path=\"*/META-INF\"");
objfile.println("PathCheck fn=\"deny-existence\" path=\"*/META-INF/*\"");
objfile.println();
objfile.println("</Object>");
objfile.println();
objfile.println("#######################################################");
objfile.println("# New object to execute your servlet requests.");
objfile.println("#######################################################");
objfile.println("<Object name=" + objectName + ">");
objfile.println("ObjectType fn=force-type type=text/html");
objfile.println("Service fn=\"jk_service\" worker=\""+ jkWorker + "\" path=\"/*\"");
objfile.println("</Object>");
objfile.println();
if( !forwardAll ) {
objfile.println("#######################################################");
objfile.println("# New object to execute URLs containing \";jsessionid=\"");
objfile.println("#######################################################");
objfile.println("<Object ppath=\"*;jsessionid=*\">");
objfile.println("ObjectType fn=force-type type=text/html");
objfile.println("Service fn=\"jk_service\" worker=\""+ jkWorker + "\" path=\"/*\"");
objfile.println("</Object>");
objfile.println();
}
}
// -------------------- Forward all mode --------------------
/** Forward all requests for a context to tomcat.
The default.
*/
private void generateStupidMappings(Context context, PrintWriter objfile )
{
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in forward-all mode ");
return;
}
objfile.println("NameTrans fn=\"assign-name\" from=\"" + ctxPath + "\" name=\"" + objectName + "\"");
objfile.println("NameTrans fn=\"assign-name\" from=\"" + ctxPath + "/*\" name=\"" + objectName + "\"");
}
// -------------------- Netscape serves static mode --------------------
// This is not going to work for all apps. We fall back to stupid mode.
private void generateContextMappings(Context context, PrintWriter objfile )
{
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log("Ignoring root context in non-forward-all mode ");
return;
}
// Static files will be served by Netscape
objfile.println("#########################################################");
objfile.println("# Auto configuration for the " + nPath + " context starts.");
objfile.println("#########################################################");
objfile.println();
// XXX Need to determine what if/how static mappings are done
// InvokerInterceptor - it doesn't have a container,
// but it's implemented using a special module.
// XXX we need to better collect all mappings
addMapping( ctxPath + "/servlet/*", objfile );
Enumeration servletMaps=context.getContainers();
while( servletMaps.hasMoreElements() ) {
Container ct=(Container)servletMaps.nextElement();
addMapping( context, ct , objfile );
}
// XXX ErrorDocument
// Security and filter mappings
}
/** Add a Netscape extension mapping.
*/
protected boolean addExtensionMapping( String ctxPath, String ext,
PrintWriter objfile )
{
if( debug > 0 )
log( "Adding extension map for " + ctxPath + "/*." + ext );
objfile.println("NameTrans fn=\"assign-name\" from=\"" +
ctxPath + "/*." + ext + "\" name=\"" + objectName + "\"");
return true;
}
/** Add a fulling specified Netscape mapping.
*/
protected boolean addMapping( String fullPath, PrintWriter objfile ) {
if( debug > 0 )
log( "Adding map for " + fullPath );
if( fullPath.endsWith("/*") ) {
objfile.println("NameTrans fn=\"assign-name\" from=\""
+ fullPath.substring(0, fullPath.length() - 2)
+ "\" name=\"" + objectName + "\"");
}
objfile.println("NameTrans fn=\"assign-name\" from=\"" +
fullPath + "\" name=\"" + objectName + "\"");
return true;
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>