NSConfigpublic class NSConfig extends BaseJkConfig 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.
|
Fields Summary |
---|
private static org.apache.juli.logging.Log | log | public static final String | WORKERS_CONFIG | public static final String | NS_CONFIG | public static final String | NSAPI_LOG_LOCATION | public static final String | NSAPI_REDIRECTORdefault location of nsapi plug-in. | private File | objConfig | private File | nsapiJk | private String | objectName |
Constructors Summary |
---|
public NSConfig()
|
Methods Summary |
---|
protected boolean | addMapping(java.lang.String ctxPath, java.lang.String ext, java.io.PrintWriter objfile)Add a Netscape extension mapping.
if( log.isDebugEnabled() )
log.debug( "Adding extension map for " + ctxPath + "/*." + ext );
if(! ext.startsWith("/") )
ext = "/" + ext;
if(ext.length() > 1)
objfile.println("NameTrans fn=\"assign-name\" from=\"" +
ctxPath + ext + "\" name=\"" + objectName + "\"");
return true;
| protected boolean | addMapping(java.lang.String fullPath, java.io.PrintWriter objfile)Add a fulling specified Netscape mapping.
if( log.isDebugEnabled() )
log.debug( "Adding map for " + fullPath );
objfile.println("NameTrans fn=\"assign-name\" from=\"" +
fullPath + "\" name=\"" + objectName + "\"");
return true;
| protected void | generateContextMappings(org.apache.catalina.Context context, java.io.PrintWriter objfile)
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log.debug("Ignoring root context in non-forward-all mode ");
return;
}
objfile.println("<Object name=" + context.getName() + ">");
// 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
if(context.getLoginConfig() != null) {
String loginPage = context.getLoginConfig().getLoginPage();
if(loginPage != null) {
int lpos = loginPage.lastIndexOf("/");
String jscurl = loginPage.substring(0,lpos+1) + "j_security_check";
addMapping( ctxPath, jscurl, objfile);
}
}
String [] servletMaps=context.findServletMappings();
for(int ii=0; ii < servletMaps.length; ii++) {
addMapping( ctxPath , servletMaps[ii] , objfile );
}
objfile.println("</Object>");
| protected boolean | generateJkHead(java.io.PrintWriter mod_jk)
log.info("Generating netscape web server config = "+objConfig );
generateNsapiHead( mod_jk );
mod_jk.println("<Object name=default>");
return true;
| protected void | generateJkTail(java.io.PrintWriter objfile)
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=\"*/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();
| private void | generateNsapiHead(java.io.PrintWriter objfile)
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();
| protected void | generateStupidMappings(org.apache.catalina.Context context, java.io.PrintWriter objfile)Forward all requests for a context to tomcat.
The default.
String ctxPath = context.getPath();
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
if( noRoot && "".equals(ctxPath) ) {
log.debug("Ignoring root context in forward-all mode ");
return;
}
objfile.println("<Object name=" + context.getName() + ">");
objfile.println("NameTrans fn=\"assign-name\" from=\"" + ctxPath + "\" name=\"" + objectName + "\"");
objfile.println("NameTrans fn=\"assign-name\" from=\"" + ctxPath + "/*\" name=\"" + objectName + "\"");
objfile.println("</Object>");
| protected java.io.PrintWriter | getWriter()
String abObjConfig = objConfig.getAbsolutePath();
return new PrintWriter(new FileWriter(abObjConfig,append));
| protected void | initProperties()Initialize defaults for properties that are not set
explicitely
super.initProperties();
objConfig=getConfigFile( objConfig, configHome, NS_CONFIG);
workersConfig=getConfigFile( workersConfig, configHome, WORKERS_CONFIG);
if( nsapiJk == null )
nsapiJk=new File(NSAPI_REDIRECTOR);
else
nsapiJk =getConfigFile( nsapiJk, configHome, NSAPI_REDIRECTOR );
jkLog=getConfigFile( jkLog, configHome, NSAPI_LOG_LOCATION);
| public void | setNsapiJk(java.lang.String path)set the path to the nsapi plugin module
nsapiJk=( path==null?null:new File(path));
| public void | setObjConfig(java.lang.String path)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.
objConfig= (path==null)?null:new File(path);
| public void | setObjectName(java.lang.String name)Set the name for the Object that implements the
jk_service call.
objectName = name;
|
|