|
|||||||||
| Home >> All >> org >> apache >> ajp >> tomcat4 >> [ config overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.apache.ajp.tomcat4.config
Class BaseJkConfig
java.lang.Objectorg.apache.ajp.tomcat4.config.BaseJkConfig
- All Implemented Interfaces:
- org.apache.catalina.LifecycleListener
- Direct Known Subclasses:
- ApacheConfig, IISConfig, NSConfig
- public class BaseJkConfig
- extends java.lang.Object
- implements org.apache.catalina.LifecycleListener
- extends java.lang.Object
Base class for automatic jk based configurations based on the Tomcat server.xml settings and the war contexts initialized during startup.
This config interceptor is enabled by inserting a Config element in the <ContextManager> tag body inside the server.xml file like so:
< ContextManager ... >
...
<???Config 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.
- workersConfig - path to workers.properties file used by jk connector. If not set, defaults to "conf/jk/workers.properties".
- jkLog - path to log file to be used by jk connector.
- 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 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 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.
- Version:
- $Revision: 299797 $
| Field Summary | |
protected boolean |
append
|
protected java.io.File |
configHome
|
protected int |
debug
|
protected boolean |
forwardAll
|
protected java.lang.String |
jkDebug
|
protected java.io.File |
jkLog
|
protected java.lang.String |
jkWorker
|
private static org.apache.commons.logging.Log |
log
|
protected boolean |
noRoot
|
protected boolean |
regenerate
|
protected java.lang.String |
tomcatHome
|
protected java.io.File |
workersConfig
|
| Constructor Summary | |
BaseJkConfig()
|
|
| Method Summary | |
protected boolean |
addExtensionMapping(java.lang.String ctxPath,
java.lang.String ext,
java.io.PrintWriter pw)
Add an extension mapping. |
protected boolean |
addMapping(java.lang.String fullPath,
java.io.PrintWriter pw)
Add a fulling specified mapping. |
void |
execute(org.apache.catalina.LifecycleEvent evt)
Generate configuration files. |
void |
executeContext(org.apache.catalina.Context context,
java.io.PrintWriter mod_jk)
executes the ApacheConfig interceptor. |
protected void |
executeEngine(org.apache.catalina.Engine egn,
java.io.PrintWriter mod_jk)
Generate configuration files. |
protected void |
executeHost(org.apache.catalina.Host hst,
java.io.PrintWriter mod_jk)
Generate configuration files. |
void |
executeServer(org.apache.catalina.Server svr,
java.io.PrintWriter mod_jk)
Generate configuration files. |
protected void |
generateContextMappings(org.apache.catalina.Context context,
java.io.PrintWriter mod_jk)
|
protected boolean |
generateJkHead(java.io.PrintWriter mod_jk)
Generate general options |
protected void |
generateJkTail(java.io.PrintWriter mod_jk)
Generate general options |
protected void |
generateSSLConfig(java.io.PrintWriter mod_jk)
Generate SSL options |
protected void |
generateStupidMappings(org.apache.catalina.Context context,
java.io.PrintWriter mod_jk)
|
protected void |
generateVhostHead(org.apache.catalina.Host host,
java.io.PrintWriter mod_jk)
Generate Virtual Host start |
protected void |
generateVhostTail(org.apache.catalina.Host host,
java.io.PrintWriter mod_jk)
Generate Virtual Host end |
protected java.lang.String |
getAbsoluteDocBase(org.apache.catalina.Context context)
|
static java.io.File |
getConfigFile(java.io.File base,
java.io.File configDir,
java.lang.String defaultF)
|
protected org.apache.catalina.Host |
getHost(org.apache.catalina.Container child)
Get the host associated with this Container (if any). |
protected java.io.PrintWriter |
getWriter()
Get the output Writer. |
protected void |
initProperties()
Initialize defaults for properties that are not set explicitely |
static boolean |
isAbsolute(java.lang.String path)
|
void |
lifecycleEvent(org.apache.catalina.LifecycleEvent evt)
Generate the configuration - only when the server is completely initialized ( before starting ) |
protected void |
log(java.lang.String msg)
|
static java.lang.String |
patch(java.lang.String path)
|
void |
setAppend(boolean apnd)
Append to config file. |
void |
setConfigHome(java.lang.String dir)
set a path to the parent directory of the conf folder. |
void |
setForwardAll(boolean b)
If false, we'll try to generate a config that will let apache serve static files. |
void |
setJkDebug(java.lang.String level)
Set the verbosity level ( use debug, error, etc. |
void |
setJkLog(java.lang.String path)
set the path to the log file |
void |
setJkWorker(java.lang.String worker)
Set the AJP worker. |
void |
setNoRoot(boolean b)
Special option - do not generate mappings for the ROOT context. |
void |
setWorkersConfig(java.lang.String path)
set a path to the workers.properties file. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
log
private static org.apache.commons.logging.Log log
debug
protected int debug
configHome
protected java.io.File configHome
workersConfig
protected java.io.File workersConfig
jkLog
protected java.io.File jkLog
jkDebug
protected java.lang.String jkDebug
jkWorker
protected java.lang.String jkWorker
noRoot
protected boolean noRoot
forwardAll
protected boolean forwardAll
tomcatHome
protected java.lang.String tomcatHome
regenerate
protected boolean regenerate
append
protected boolean append
| Constructor Detail |
BaseJkConfig
public BaseJkConfig()
| Method Detail |
lifecycleEvent
public void lifecycleEvent(org.apache.catalina.LifecycleEvent evt)
- Generate the configuration - only when the server is
completely initialized ( before starting )
- Specified by:
lifecycleEventin interfaceorg.apache.catalina.LifecycleListener
execute
public void execute(org.apache.catalina.LifecycleEvent evt)
- Generate configuration files. Override with method to generate
web server specific configuration.
executeServer
public void executeServer(org.apache.catalina.Server svr, java.io.PrintWriter mod_jk)
- Generate configuration files. Override with method to generate
web server specific configuration.
generateSSLConfig
protected void generateSSLConfig(java.io.PrintWriter mod_jk)
- Generate SSL options
generateJkHead
protected boolean generateJkHead(java.io.PrintWriter mod_jk)
- Generate general options
generateJkTail
protected void generateJkTail(java.io.PrintWriter mod_jk)
- Generate general options
generateVhostHead
protected void generateVhostHead(org.apache.catalina.Host host, java.io.PrintWriter mod_jk)
- Generate Virtual Host start
generateVhostTail
protected void generateVhostTail(org.apache.catalina.Host host, java.io.PrintWriter mod_jk)
- Generate Virtual Host end
executeEngine
protected void executeEngine(org.apache.catalina.Engine egn, java.io.PrintWriter mod_jk)
- Generate configuration files. Override with method to generate
web server specific configuration.
executeHost
protected void executeHost(org.apache.catalina.Host hst, java.io.PrintWriter mod_jk)
- Generate configuration files. Override with method to generate
web server specific configuration.
executeContext
public void executeContext(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)
- executes the ApacheConfig interceptor. This method generates apache
configuration files for use with mod_jk.
generateStupidMappings
protected void generateStupidMappings(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)
generateContextMappings
protected void generateContextMappings(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)
getWriter
protected java.io.PrintWriter getWriter() throws java.io.IOException
- Get the output Writer. Override with method to generate
web server specific configuration.
getHost
protected org.apache.catalina.Host getHost(org.apache.catalina.Container child)
- Get the host associated with this Container (if any).
setAppend
public void setAppend(boolean apnd)
- Append to config file.
Set to
trueif the config information should be appended.
setForwardAll
public void setForwardAll(boolean b)
- 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.
setNoRoot
public void setNoRoot(boolean 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.
setConfigHome
public void setConfigHome(java.lang.String dir)
- 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".
However, if the path is set to an absolute path, this attribute is ignored.
If not set, execute() will set this to TOMCAT_HOME.
setWorkersConfig
public void setWorkersConfig(java.lang.String path)
- set a path to the workers.properties file.
setJkLog
public void setJkLog(java.lang.String path)
- set the path to the log file
setJkDebug
public void setJkDebug(java.lang.String level)
- Set the verbosity level
( use debug, error, etc. ) If not set, no log is written.
setJkWorker
public void setJkWorker(java.lang.String worker)
- Set the AJP worker.
initProperties
protected void initProperties()
- Initialize defaults for properties that are not set
explicitely
addExtensionMapping
protected boolean addExtensionMapping(java.lang.String ctxPath, java.lang.String ext, java.io.PrintWriter pw)
- Add an extension mapping. Override with method to generate
web server specific configuration
addMapping
protected boolean addMapping(java.lang.String fullPath, java.io.PrintWriter pw)
- Add a fulling specified mapping. Override with method to generate
web server specific configuration
getAbsoluteDocBase
protected java.lang.String getAbsoluteDocBase(org.apache.catalina.Context context)
getConfigFile
public static java.io.File getConfigFile(java.io.File base, java.io.File configDir, java.lang.String defaultF)
patch
public static java.lang.String patch(java.lang.String path)
isAbsolute
public static boolean isAbsolute(java.lang.String path)
log
protected void log(java.lang.String msg)
|
|||||||||
| Home >> All >> org >> apache >> ajp >> tomcat4 >> [ config overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||