| Methods Summary |
|---|
| protected boolean | addExtensionMapping(java.lang.String ctxPath, java.lang.String ext, java.io.PrintWriter mod_jk)Add an Apache extension mapping.
if( log.isDebugEnabled() )
log.debug( "Adding extension map for " + ctxPath + "/*." + ext );
mod_jk.println(indent + "JkMount " + ctxPath + "/*." + ext
+ " " + jkWorker);
return true;
|
| protected boolean | addMapping(java.lang.String fullPath, java.io.PrintWriter mod_jk)Add a fulling specified Appache mapping.
if( log.isDebugEnabled() )
log.debug( "Adding map for " + fullPath );
mod_jk.println(indent + "JkMount " + fullPath + " " + jkWorker );
return true;
|
| protected boolean | addMapping(java.lang.String ctxP, java.lang.String ext, java.io.PrintWriter mod_jk)Add a partially specified Appache mapping.
if( log.isDebugEnabled() )
log.debug( "Adding map for " + ext );
if(! ext.startsWith("/") )
ext = "/" + ext;
if(ext.length() > 1)
mod_jk.println(indent + "JkMount " + ctxP + ext+ " " + jkWorker );
return true;
|
| protected void | generateContextMappings(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)
String ctxPath = context.getPath();
Host vhost = getHost(context);
if( noRoot && "".equals(ctxPath) ) {
log.debug("Ignoring root context in non-forward-all mode ");
return;
}
mod_jk.println();
mod_jk.println(indent + "#################### " +
((vhost!=null ) ? vhost.getName() + ":" : "" ) +
(("".equals(ctxPath)) ? "/" : ctxPath ) +
" ####################" );
mod_jk.println();
// Dynamic /servet pages go to Tomcat
generateStaticMappings( context, mod_jk );
// 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, mod_jk);
}
}
String [] servletMaps = context.findServletMappings();
for(int ii=0; ii < servletMaps.length; ii++) {
addMapping( ctxPath, servletMaps[ii] , mod_jk );
}
|
| protected boolean | generateJkHead(java.io.PrintWriter mod_jk)Generate the loadModule and general options
mod_jk.println("########## Auto generated on " + new Date() +
"##########" );
mod_jk.println();
// Fail if mod_jk not found, let the user know the problem
// instead of running into problems later.
if( ! modJk.exists() ) {
log.info( "mod_jk location: " + modJk );
log.info( "Make sure it is installed corectly or " +
" set the config location" );
log.info( "Using <Listener className=\""+getClass().getName()+"\" modJk=\"PATH_TO_MOD_JK.SO_OR_DLL\" />" );
}
// Verify the file exists !!
mod_jk.println("<IfModule !mod_jk.c>");
mod_jk.println(" LoadModule jk_module \""+
modJk.toString().replace('\\",'/") +
"\"");
mod_jk.println("</IfModule>");
mod_jk.println();
// Fail if workers file not found, let the user know the problem
// instead of running into problems later.
if( ! workersConfig.exists() ) {
log.warn( "Can't find workers.properties at " + workersConfig );
log.warn( "Please install it in the default location or " +
" set the config location" );
log.warn( "Using <Listener className=\"" + getClass().getName() + "\" workersConfig=\"FULL_PATH\" />" );
return false;
}
mod_jk.println("JkWorkersFile \""
+ workersConfig.toString().replace('\\", '/")
+ "\"");
mod_jk.println("JkLogFile \""
+ jkLog.toString().replace('\\", '/")
+ "\"");
mod_jk.println();
if( jkDebug != null ) {
mod_jk.println("JkLogLevel " + jkDebug);
mod_jk.println();
}
return true;
|
| private void | generateNameVirtualHost(java.io.PrintWriter mod_jk, java.lang.String ip)
if( !NamedVirtualHosts.containsKey(ip) ) {
mod_jk.println("NameVirtualHost " + ip + "");
NamedVirtualHosts.put(ip,ip);
}
|
| protected void | generateSSLConfig(java.io.PrintWriter mod_jk)
if( ! sslExtract ) {
mod_jk.println("JkExtractSSL Off");
}
if( ! "HTTPS".equalsIgnoreCase( sslHttpsIndicator ) ) {
mod_jk.println("JkHTTPSIndicator " + sslHttpsIndicator);
}
if( ! "SSL_SESSION_ID".equalsIgnoreCase( sslSessionIndicator )) {
mod_jk.println("JkSESSIONIndicator " + sslSessionIndicator);
}
if( ! "SSL_CIPHER".equalsIgnoreCase( sslCipherIndicator )) {
mod_jk.println("JkCIPHERIndicator " + sslCipherIndicator);
}
if( ! "SSL_CLIENT_CERT".equalsIgnoreCase( sslCertsIndicator )) {
mod_jk.println("JkCERTSIndicator " + sslCertsIndicator);
}
mod_jk.println();
|
| private void | generateStaticMappings(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)Mappings for static content. XXX need to add welcome files,
mime mappings ( all will be handled by Mime and Static modules of
apache ).
String ctxPath = context.getPath();
// Calculate the absolute path of the document base
String docBase = getApacheDocBase(context);
if( !"".equals(ctxPath) ) {
// Static files will be served by Apache
mod_jk.println(indent + "# Static files ");
mod_jk.println(indent + "Alias " + ctxPath + " \"" + docBase + "\"");
mod_jk.println();
} else {
if ( getHost(context) != null ) {
mod_jk.println(indent + "DocumentRoot \"" +
getApacheDocBase(context) + "\"");
} else {
// For root context, ask user to update DocumentRoot setting.
// Using "Alias / " interferes with the Alias for other contexts.
mod_jk.println(indent +
"# Be sure to update DocumentRoot");
mod_jk.println(indent +
"# to point to: \"" + docBase + "\"");
}
}
mod_jk.println(indent + "<Directory \"" + docBase + "\">");
mod_jk.println(indent + " Options Indexes FollowSymLinks");
generateWelcomeFiles(context, mod_jk);
// XXX XXX Here goes the Mime types and welcome files !!!!!!!!
mod_jk.println(indent + "</Directory>");
mod_jk.println();
// Deny serving any files from WEB-INF
mod_jk.println();
mod_jk.println(indent +
"# Deny direct access to WEB-INF and META-INF");
mod_jk.println(indent + "#");
mod_jk.println(indent + "<Location \"" + ctxPath + "/WEB-INF/*\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Location>");
// Deny serving any files from META-INF
mod_jk.println();
mod_jk.println(indent + "<Location \"" + ctxPath + "/META-INF/*\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Location>");
if (File.separatorChar == '\\") {
mod_jk.println(indent + "#");
mod_jk.println(indent +
"# Use Directory too. On Windows, Location doesn't"
+ " work unless case matches");
mod_jk.println(indent + "#");
mod_jk.println(indent +
"<Directory \"" + docBase + "/WEB-INF/\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Directory>");
mod_jk.println();
mod_jk.println(indent +
"<Directory \"" + docBase + "/META-INF/\">");
mod_jk.println(indent + " AllowOverride None");
mod_jk.println(indent + " deny from all");
mod_jk.println(indent + "</Directory>");
}
mod_jk.println();
|
| protected void | generateStupidMappings(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)Forward all requests for a context to tomcat.
The default.
String ctxPath = context.getPath();
if(ctxPath == null)
return;
String nPath=("".equals(ctxPath)) ? "/" : ctxPath;
mod_jk.println();
mod_jk.println(indent + "JkMount " + nPath + " " + jkWorker );
if( "".equals(ctxPath) ) {
mod_jk.println(indent + "JkMount " + nPath + "* " + jkWorker );
if ( context.getParent() instanceof Host ) {
mod_jk.println(indent + "DocumentRoot \"" +
getApacheDocBase(context) + "\"");
} else {
mod_jk.println(indent +
"# To avoid Apache serving root welcome files from htdocs, update DocumentRoot");
mod_jk.println(indent +
"# to point to: \"" + getApacheDocBase(context) + "\"");
}
} else {
mod_jk.println(indent + "JkMount " + nPath + "/* " + jkWorker );
}
|
| protected void | generateVhostHead(org.apache.catalina.Host host, java.io.PrintWriter mod_jk)
mod_jk.println();
String vhostip = host.getName();
String vhost = vhostip;
int ppos = vhost.indexOf(":");
if(ppos >= 0)
vhost = vhost.substring(0,ppos);
mod_jk.println("<VirtualHost "+ vhostip + ">");
mod_jk.println(" ServerName " + vhost );
String [] aliases=host.findAliases();
if( aliases.length > 0 ) {
mod_jk.print(" ServerAlias " );
for( int ii=0; ii < aliases.length ; ii++) {
mod_jk.print( aliases[ii] + " " );
}
mod_jk.println();
}
indent=" ";
|
| protected void | generateVhostTail(org.apache.catalina.Host host, java.io.PrintWriter mod_jk)
mod_jk.println("</VirtualHost>");
indent="";
|
| private void | generateWelcomeFiles(org.apache.catalina.Context context, java.io.PrintWriter mod_jk)
String wf[]=context.findWelcomeFiles();
if( wf==null || wf.length == 0 )
return;
mod_jk.print(indent + " DirectoryIndex ");
for( int i=0; i<wf.length ; i++ ) {
mod_jk.print( wf[i] + " " );
}
mod_jk.println();
|
| private java.lang.String | getApacheDocBase(org.apache.catalina.Context context)
// Calculate the absolute path of the document base
String docBase = getAbsoluteDocBase(context);
if (File.separatorChar == '\\") {
// use separator preferred by Apache
docBase = docBase.replace('\\",'/");
}
return docBase;
|
| private java.lang.String | getVirtualHostAddress(java.lang.String vhost, java.lang.String vhostip)
if( vhostip == null ) {
if ( vhost != null && vhost.length() > 0 && Character.isDigit(vhost.charAt(0)) )
vhostip=vhost;
else
vhostip="*";
}
return vhostip;
|
| protected java.io.PrintWriter | getWriter()
String abJkConfig = jkConfig.getAbsolutePath();
return new PrintWriter(new FileWriter(abJkConfig, append));
|
| protected void | initProperties()Initialize defaults for properties that are not set
explicitely
super.initProperties();
jkConfig= getConfigFile( jkConfig, configHome, MOD_JK_CONFIG);
workersConfig=getConfigFile( workersConfig, configHome,
WORKERS_CONFIG);
if( modJk == null )
modJk=new File(MOD_JK);
else
modJk=getConfigFile( modJk, configHome, MOD_JK );
jkLog=getConfigFile( jkLog, configHome, JK_LOG_LOCATION);
|
| public void | setCertsIndicator(java.lang.String s)What is the indicator for the client SSL certificated(default
is SSL_CLIENT_CERT
sslCertsIndicator=s;
|
| public void | setCipherIndicator(java.lang.String s)What is the indicator for client SSL cipher suit (default is SSL_CIPHER)
sslCipherIndicator=s;
|
| 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)
this.sslExtract=sslMode;
|
| public void | setHttpsIndicator(java.lang.String s)What is the indicator for SSL (default is HTTPS)
sslHttpsIndicator=s;
|
| public void | setJkConfig(java.lang.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.
jkConfig= (path==null)?null:new File(path);
|
| public void | setModJk(java.lang.String path)set the path to the mod_jk Apache Module
modJk=( path==null?null:new File(path));
|
| public void | setSessionIndicator(java.lang.String s)What is the indicator for SSL session (default is SSL_SESSION_ID)
sslSessionIndicator=s;
|
