alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*   
 *  Copyright 1999-2004 The Apache Sofware Foundation.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.tomcat.modules.config;

import java.io.File;
import java.io.FileWriter;
import java.io.PrintWriter;
import java.util.Date;
import java.util.Enumeration;

import org.apache.tomcat.core.Container;
import org.apache.tomcat.core.Context;
import org.apache.tomcat.core.ContextManager;
import org.apache.tomcat.core.TomcatException;
import org.apache.tomcat.util.io.FileUtil;
import org.apache.tomcat.util.log.Log;


/**
    Generates automatic Netscape nsapi_redirect configurations based on
    the Tomcat server.xml settings and the war contexts
    initialized during startup.
    

This config interceptor is enabled by inserting an NSConfig element in the <ContextManager> tag body inside the server.xml file like so:

    * < ContextManager ... >
    *   ...
    *   <NSConfig options />
    *   ...
    * < /ContextManager >
    
where options can include any of the following attributes:
  • configHome - default parent directory for the following paths. If not set, this defaults to TOMCAT_HOME. Ignored whenever any of the following paths is absolute.
  • objConfig - path to use for writing Netscape obj.conf file. If not set, defaults to "conf/auto/obj.conf".
  • objectName - Name of the Object to execute the requests. Defaults to "servlet".
  • workersConfig - path to workers.properties file used by nsapi_redirect. If not set, defaults to "conf/jk/workers.properties".
  • nsapiJk - 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.
  • jkLog - path to log file to be used by nsapi_redirect.
  • jkDebug - Loglevel setting. May be debug, info, error, or emerg. If not set, defaults to emerg.
  • jkWorker 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".
  • forwardAll - 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.
  • noRoot - 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.

@author Costin Manolache @author Larry Isaacs @author Gal Shachor @version $Revision: 1.12 $ */ 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.

@param path 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 path 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 name 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 cm.getHome().

@param cm 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(""); // 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=\"\""); 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(""); objfile.println(); objfile.println("#######################################################"); objfile.println("# New object to execute your servlet requests."); objfile.println("#######################################################"); objfile.println(""); objfile.println("ObjectType fn=force-type type=text/html"); objfile.println("Service fn=\"jk_service\" worker=\""+ jkWorker + "\" path=\"/*\""); objfile.println(""); objfile.println(); if( !forwardAll ) { objfile.println("#######################################################"); objfile.println("# New object to execute URLs containing \";jsessionid=\""); objfile.println("#######################################################"); objfile.println(""); objfile.println("ObjectType fn=force-type type=text/html"); objfile.println("Service fn=\"jk_service\" worker=\""+ jkWorker + "\" path=\"/*\""); objfile.println(""); 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; } }

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.