Generates automatic apache mod_jk configurations based on
the Tomcat server.xml settings and the war contexts
initialized during startup.
This config interceptor is enabled by inserting an ApacheConfig
Listener
in
the server.xml file like so:
<32Server ... >
...
org.apache.ajp.tomcat4.config.ApacheConfig
options />
...
<32/Server >
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.
- jkConfig - path to use for writing Apache mod_jk conf file. If
not set, defaults to
"conf/auto/mod_jk.conf".
- workersConfig - path to workers.properties file used by
mod_jk. If not set, defaults to
"conf/jk/workers.properties".
- modJk - 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.
- jkLog - path to log file to be used by mod_jk.
- jkDebug - JK 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 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.
- 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 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.
addExtensionMapping
protected boolean addExtensionMapping(String ctxPath,
String ext,
PrintWriter mod_jk)
Add an Apache extension mapping.
- addExtensionMapping in interface BaseJkConfig
addMapping
protected boolean addMapping(String fullPath,
PrintWriter mod_jk)
Add a fulling specified Appache mapping.
- addMapping in interface BaseJkConfig
addMapping
protected boolean addMapping(String ctxP,
String ext,
PrintWriter mod_jk)
Add a partially specified Appache mapping.
generateContextMappings
protected void generateContextMappings(Context context,
PrintWriter mod_jk)
- generateContextMappings in interface BaseJkConfig
generateJkHead
protected boolean generateJkHead(PrintWriter mod_jk)
Generate the loadModule and general options
- generateJkHead in interface BaseJkConfig
generateSSLConfig
protected void generateSSLConfig(PrintWriter mod_jk)
Generate SSL options
- generateSSLConfig in interface BaseJkConfig
generateStupidMappings
protected void generateStupidMappings(Context context,
PrintWriter mod_jk)
Forward all requests for a context to tomcat.
The default.
- generateStupidMappings in interface BaseJkConfig
generateVhostHead
protected void generateVhostHead(Host host,
PrintWriter mod_jk)
Generate Virtual Host start
- generateVhostHead in interface BaseJkConfig
generateVhostTail
protected void generateVhostTail(Host host,
PrintWriter mod_jk)
Generate Virtual Host end
- generateVhostTail in interface BaseJkConfig
getWriter
protected PrintWriter getWriter()
throws IOException
Get the output Writer. Override with method to generate
web server specific configuration.
- getWriter in interface BaseJkConfig
initProperties
protected void initProperties()
Initialize defaults for properties that are not set
explicitely
- initProperties in interface BaseJkConfig
setCertsIndicator
public void setCertsIndicator(String s)
What is the indicator for the client SSL certificated(default
is SSL_CLIENT_CERT
setCipherIndicator
public void setCipherIndicator(String s)
What is the indicator for client SSL cipher suit (default is SSL_CIPHER)
setExtractSSL
public void setExtractSSL(boolean sslMode)
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)
setHttpsIndicator
public void setHttpsIndicator(String s)
What is the indicator for SSL (default is HTTPS)
setJkConfig
public void setJkConfig(String path)
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.
setModJk
public void setModJk(String path)
set the path to the mod_jk Apache Module
setSessionIndicator
public void setSessionIndicator(String s)
What is the indicator for SSL session (default is SSL_SESSION_ID)