org.apache.tomcat.modules.config
Class NSConfig
java.lang.Object
|
+--org.apache.tomcat.core.BaseInterceptor
|
+--org.apache.tomcat.modules.config.BaseJkConfig
|
+--org.apache.tomcat.modules.config.NSConfig
- public 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.
- Version:
- $Revision: 1.10 $
- Author:
- Costin Manolache, Larry Isaacs, Gal Shachor
Method Summary |
protected boolean |
addExtensionMapping(java.lang.String ctxPath,
java.lang.String ext,
java.io.PrintWriter objfile)
Add a Netscape extension mapping. |
protected boolean |
addMapping(java.lang.String fullPath,
java.io.PrintWriter objfile)
Add a fulling specified Netscape mapping. |
void |
execute(ContextManager cm)
executes the NSConfig interceptor. |
protected void |
initProperties(ContextManager cm)
Initialize defaults for properties that are not set
explicitely |
void |
setNsapiJk(java.lang.String path)
set the path to the nsapi plugin module |
void |
setObjConfig(java.lang.String path)
set the path to the output file for the auto-generated
isapi_redirect registry file. |
void |
setObjectName(java.lang.String name)
Set the name for the Object that implements the
jk_service call. |
Methods inherited from class org.apache.tomcat.modules.config.BaseJkConfig |
addInterceptor, addMapping, contextInit, engineState, getAbsoluteDocBase, initWorker, setConfigHome, setForwardAll, setJkDebug, setJkLog, setJkWorker, setNoRoot, setWorkersConfig |
Methods inherited from class org.apache.tomcat.core.BaseInterceptor |
addContainer, addContext, addHandler, addSecurityConstraint, afterBody, authenticate, authorize, beforeBody, beforeCommit, contextMap, contextShutdown, contextState, engineInit, engineShutdown, engineStart, engineStop, findSession, getContext, getContextManager, getDebug, getInfo, getLog, getNote, getNote, handleError, log, log, log, log, postReadRequest, postRequest, postService, postServletDestroy, postServletInit, preService, preServletDestroy, preServletInit, registerHooks, reload, removeContainer, removeContext, removeHandler, removeInterceptor, requestMap, sessionState, setContext, setContextManager, setDebug, setInfo, setNote, setNote |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
WORKERS_CONFIG
public static final java.lang.String WORKERS_CONFIG
NS_CONFIG
public static final java.lang.String NS_CONFIG
NSAPI_LOG_LOCATION
public static final java.lang.String NSAPI_LOG_LOCATION
NSAPI_REDIRECTOR
public static java.lang.String NSAPI_REDIRECTOR
- default location of nsapi plug-in.
NSConfig
public NSConfig()
setObjConfig
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.
- Parameters:
path
- String path to a file
setNsapiJk
public void setNsapiJk(java.lang.String path)
- set the path to the nsapi plugin module
- Parameters:
path
- String path to a file
setObjectName
public void setObjectName(java.lang.String name)
- Set the name for the Object that implements the
jk_service call.
- Parameters:
name
- Name of the obj.conf Object
initProperties
protected void initProperties(ContextManager cm)
- Initialize defaults for properties that are not set
explicitely
- Overrides:
initProperties
in class BaseJkConfig
execute
public void execute(ContextManager cm)
throws TomcatException
- 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().
- Overrides:
execute
in class BaseJkConfig
- Parameters:
cm
- a ContextManager object.
addExtensionMapping
protected boolean addExtensionMapping(java.lang.String ctxPath,
java.lang.String ext,
java.io.PrintWriter objfile)
- Add a Netscape extension mapping.
- Overrides:
addExtensionMapping
in class BaseJkConfig
addMapping
protected boolean addMapping(java.lang.String fullPath,
java.io.PrintWriter objfile)
- Add a fulling specified Netscape mapping.
- Overrides:
addMapping
in class BaseJkConfig
Copyright © 2001 Apache Software Foundation. All Rights Reserved.