/**
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.openejb.tomcat.loader;
import org.apache.openejb.loader.Embedder;
import org.apache.openejb.loader.SystemInstance;
import java.io.File;
import java.util.Properties;
/**
* This class should only be loadded and used via reflection from TomcatEmbedder.
*
* Everything that happens up to the point of calling this particular method
* (except setting openejb.war) ultimately means nothing and does not matter
* to the integration.
*
* Requires openejb.war to be set, the sets the following properties:
*
* System properties:
* set openejb.home -> catalina.home
* set openejb.base -> catalina.base
* set openejb.war -> $openejb.war
* set tomcat.version if not set
* set tomcat.built if not set
*
* Local properties:
* set openejb.loader -> tomcat-system
* set openejb.libs -> $openejb.war/lib
*
* With these properties setup, this class with construct an {@link Embedder}
* using the "org.apache.openejb.tomcat.catalina.TomcatLoader" as the loader.
*
* The Embedder will use the openejb.libs property to find all the jars to be loaded
* then it will use the openejb.loader property to find out *how* to add them into
* the classpath of the right classloader. Once all the jars are in the required
* class loader, it loads the {@link org.apache.openejb.loader.Loader} implementation
* and calls it's {@link org.apache.openejb.loader.Loader#init} method.
*
* See org.apache.openejb.tomcat.catalina.TomcatLoader for the next part of the story
*/
class TomcatHook {
@SuppressWarnings({"UnusedDeclaration"})
private static void hook(Properties properties) {
// verify properties and make sure it contains the openejb.war property
if (properties == null) throw new NullPointerException("properties is null");
if (!properties.containsKey("openejb.war")) throw new IllegalArgumentException("properties must contain the openejb.war property");
// get the openejb directory (under webapps) using the openejb.war property
File openejbWar = new File(properties.getProperty("openejb.war"));
if (!openejbWar.isDirectory()) {
throw new IllegalArgumentException("openejb.war is not a directory: " + openejbWar);
}
// if SystemInstance is already initialized, then return
if (SystemInstance.isInitialized()) {
return;
}
// set the openejb.loader property to tomcat-system
properties.setProperty("openejb.loader", "tomcat-system");
// get the value of catalina.home and set it to openejb.home
String catalinaHome = System.getProperty("catalina.home");
properties.setProperty("openejb.home", catalinaHome);
System.setProperty("openejb.home", catalinaHome);
//get the value of catalina.base and set it to openejb.base
String catalinaBase = System.getProperty("catalina.base");
properties.setProperty("openejb.base", catalinaBase);
System.setProperty("openejb.base", catalinaBase);
// Set the openejb.war property as a *System* property
System.setProperty("openejb.war", openejbWar.getAbsolutePath());
// set the property openejb.libs to contain the absolute path of the lib directory of openejb webapp
File libDir = new File(openejbWar, "lib");
String libPath = libDir.getAbsolutePath();
properties.setProperty("openejb.libs", libPath);
// System.setProperty("tomcat.version", "x.y.z.w");
// System.setProperty("tomcat.built", "mmm dd yyyy hh:mm:ss");
// set the System properties, tomcat.version, tomcat.built
try {
Properties tomcatServerInfo = new Properties();
ClassLoader classLoader = TomcatHook.class.getClassLoader();
tomcatServerInfo.load(classLoader.getResourceAsStream("org/apache/catalina/util/ServerInfo.properties"));
String serverNumber = tomcatServerInfo.getProperty("server.number");
if (serverNumber == null) {
// Tomcat5 only has server.info
String serverInfo = tomcatServerInfo.getProperty("server.info");
if (serverInfo != null) {
int slash = serverInfo.indexOf('/');
serverNumber = serverInfo.substring(slash + 1);
}
}
if (serverNumber != null) {
System.setProperty("tomcat.version", serverNumber);
}
String serverBuilt = tomcatServerInfo.getProperty("server.built");
if (serverBuilt != null) {
System.setProperty("tomcat.built", serverBuilt);
}
} catch (Throwable e) {
}
try {
// create the loader
// This init call affects only this WebappClassloader and is just required
// for runnig the Embedder. The SystemInstance will be initialized more permanently
// in the parent classloader once the required libraries are added.
SystemInstance.init(properties);
// This guy does the magic of squishing the openejb libraries into the parent classloader
// and kicking off the reall integration.
Embedder embedder = new Embedder("org.apache.openejb.tomcat.catalina.TomcatLoader");
embedder.init(properties);
} catch (Exception e) {
e.printStackTrace();
}
}
}