From a76f2c08ce76d75096b875d25e55deda9c9a8644 Mon Sep 17 00:00:00 2001 From: antelder Date: Mon, 25 May 2009 07:17:54 +0000 Subject: Add module for Tomcat deep integration git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@778316 13f79535-47bb-0310-9956-ffa450edef68 --- java/sca/distribution/tomcat/tomcat-hook/LICENSE | 205 +++++++++++++++++++++ .../tomcat/tomcat-hook/META-INF/MANIFEST.MF | 25 +++ java/sca/distribution/tomcat/tomcat-hook/NOTICE | 7 + java/sca/distribution/tomcat/tomcat-hook/pom.xml | 70 +++++++ .../sca/tomcat/TuscanyLifecycleListener.java | 146 +++++++++++++++ .../tuscany/sca/tomcat/TuscanyStandardContext.java | 84 +++++++++ 6 files changed, 537 insertions(+) create mode 100644 java/sca/distribution/tomcat/tomcat-hook/LICENSE create mode 100644 java/sca/distribution/tomcat/tomcat-hook/META-INF/MANIFEST.MF create mode 100644 java/sca/distribution/tomcat/tomcat-hook/NOTICE create mode 100644 java/sca/distribution/tomcat/tomcat-hook/pom.xml create mode 100644 java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyLifecycleListener.java create mode 100644 java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyStandardContext.java (limited to 'java/sca') diff --git a/java/sca/distribution/tomcat/tomcat-hook/LICENSE b/java/sca/distribution/tomcat/tomcat-hook/LICENSE new file mode 100644 index 0000000000..6e529a25c4 --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/LICENSE @@ -0,0 +1,205 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + + + diff --git a/java/sca/distribution/tomcat/tomcat-hook/META-INF/MANIFEST.MF b/java/sca/distribution/tomcat/tomcat-hook/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..fca93beabf --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/META-INF/MANIFEST.MF @@ -0,0 +1,25 @@ +Manifest-Version: 1.0 +Export-Package: org.apache.tuscany.sca.host.webapp;version="2.0.0"; + uses:="javax.servlet,org.apache.tuscany.sca.host.http,org.apache.tuscany.sca.core" +Tool: Bnd-0.0.255 +Bundle-Name: Apache Tuscany SCA Webapp Host +Created-By: 1.6.0_07 (Sun Microsystems Inc.) +Bundle-Vendor: The Apache Software Foundation +Bundle-Version: 2.0.0 +Bnd-LastModified: 1222833658000 +Bundle-ManifestVersion: 2 +Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt +Bundle-Description: Apache Tuscany SCA Webapp Host +Import-Package: javax.naming, + javax.servlet, + javax.servlet.http, + org.apache.tuscany.sca.core;version="2.0.0", + org.apache.tuscany.sca.host.http;version="2.0.0", + org.apache.tuscany.sca.host.webapp;version="2.0.0", + org.apache.tuscany.sca.node;version="2.0.0", + org.apache.tuscany.sca.node.configuration;version="2.0.0", + org.apache.tuscany.sca.node.impl;version="2.0.0", + org.oasisopen.sca;version="2.0.0" +Bundle-SymbolicName: org.apache.tuscany.sca.host.webapp +Bundle-DocURL: http://www.apache.org/ +Bundle-RequiredExecutionEnvironment: J2SE-1.5,JavaSE-1.6 diff --git a/java/sca/distribution/tomcat/tomcat-hook/NOTICE b/java/sca/distribution/tomcat/tomcat-hook/NOTICE new file mode 100644 index 0000000000..f5792022fd --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/NOTICE @@ -0,0 +1,7 @@ +${pom.name} +Copyright (c) 2005 - 2009 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + + diff --git a/java/sca/distribution/tomcat/tomcat-hook/pom.xml b/java/sca/distribution/tomcat/tomcat-hook/pom.xml new file mode 100644 index 0000000000..6bb5adad0f --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/pom.xml @@ -0,0 +1,70 @@ + + + + 4.0.0 + + org.apache.tuscany.sca + tuscany-modules + 2.0-SNAPSHOT + ../pom.xml + + + tuscany-tomcat-hook + Apache Tuscany SCA Tomcat Hook + + + + + org.apache.tomcat + catalina + 6.0.18 + + + org.apache.tomcat + servlet-api + + + provided + + + + org.apache.tomcat + coyote + 6.0.18 + provided + + + + javax.servlet + servlet-api + 2.5 + provided + + + + org.codehaus.swizzle + swizzle-stream + 1.0.2 + provided + + + + + diff --git a/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyLifecycleListener.java b/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyLifecycleListener.java new file mode 100644 index 0000000000..9533c43acb --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyLifecycleListener.java @@ -0,0 +1,146 @@ +/* + * 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.tuscany.sca.tomcat; + +import java.io.File; + +import org.apache.catalina.Container; +import org.apache.catalina.LifecycleEvent; +import org.apache.catalina.LifecycleListener; +import org.apache.catalina.ServerFactory; +import org.apache.catalina.Service; +import org.apache.catalina.connector.Connector; +import org.apache.catalina.core.StandardEngine; +import org.apache.catalina.core.StandardHost; +import org.apache.catalina.core.StandardServer; +import org.apache.catalina.core.StandardService; +import org.apache.catalina.startup.HostConfig; + +/** + * A Tomcat LifecycleListener that initilizes the Tuscany Tomcat integration. + * It sets a System property with the location of the Tuscany runtime .war + * and configures each Tomcat Connector to use the TuscanyStandardContext. + * + * To configure Tomcat to use this add the following to the Tomcat conf/server.xml + * + */ +public class TuscanyLifecycleListener implements LifecycleListener { +// private static transient Log log = LogFactory.getLog(StandardContext.class); + + public static final String TUSCANY_WAR_PROP = "org.apache.tuscany.sca.tomcat.war"; + + private static boolean running; + public static boolean isRunning() { + return running; + } + + public TuscanyLifecycleListener() { + running = true; + } + + public void lifecycleEvent(LifecycleEvent event) { + if ("init".equals(event.getType()) && (event.getSource() instanceof StandardServer)) { + File webappDir = findTuscanyWar(); + if (webappDir == null) { +// log.warn("Tuscany disabled as Tuscany webapp not found"); + } else { + System.setProperty(TUSCANY_WAR_PROP, webappDir.getAbsolutePath()); +// log.info("Using Tuscany webapp: " + webappDir.getAbsolutePath()); + StandardServer server = (StandardServer)event.getSource(); + StandardService catalina = (StandardService)server.findService("Catalina"); + for (Connector connector : catalina.findConnectors()) { + for (Container container: connector.getContainer().findChildren()) { + if (container instanceof StandardHost) { + for (LifecycleListener listener : ((StandardHost)container).findLifecycleListeners()) { + if (listener instanceof HostConfig) { + ((HostConfig)listener).setContextClass("org.apache.tuscany.sca.tomcat.TuscanyStandardContext"); +// log.info("TuscanyStandardContext set for connector: " + container.getName() + ":" + connector.getPort()); + } + } + } + } + } + } + } + } + + private static File findTuscanyWar() { + + // in Tomcat 5.5 the Tuscany war is in the server/webapps director + String catalinaBase = System.getProperty("catalina.base"); + File serverWebapps = new File(catalinaBase, "server/webapps"); + File tuscanyWar = findTuscanyWar(serverWebapps); + if (tuscanyWar != null) { + return tuscanyWar; + } + + // in Tomcat 6 the Tuscany war is normally in webapps, but we just scan all hosts directories + for (Service service : ServerFactory.getServer().findServices()) { + Container container = service.getContainer(); + if (container instanceof StandardEngine) { + StandardEngine engine = (StandardEngine) container; + for (Container child : engine.findChildren()) { + if (child instanceof StandardHost) { + StandardHost host = (StandardHost) child; + String appBase = host.getAppBase(); + + // determine the host dir (normally webapps) + File hostDir = new File(appBase); + if (!hostDir.isAbsolute()) { + hostDir = new File(catalinaBase, appBase); + } + + tuscanyWar = findTuscanyWar(hostDir); + if (tuscanyWar != null) { + return tuscanyWar; + } + } + } + } + } + return null; + } + + private static File findTuscanyWar(File hostDir) { + if (!hostDir.isDirectory()) { + return null; + } + + // iterate over the contexts + for (File contextDir : hostDir.listFiles()) { + // does this war have a web-inf lib dir + File hookLib = new File(contextDir, "server-lib"); + if (!hookLib.isDirectory()) { + continue; + } + // iterate over the libs looking for the tuscany-tomcat-*.jar + for (File file : hookLib.listFiles()) { + if (file.getName().startsWith("tuscany-tomcat-hook-") && file.getName().endsWith(".jar")) { + // this should be in the Tuscany war... + // make sure it has a runtime directory + if (new File(contextDir, "tuscany-lib").isDirectory()) { + return contextDir; + } + } + } + } + return null; + } +} diff --git a/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyStandardContext.java b/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyStandardContext.java new file mode 100644 index 0000000000..0d6404fff9 --- /dev/null +++ b/java/sca/distribution/tomcat/tomcat-hook/src/main/java/org/apache/tuscany/sca/tomcat/TuscanyStandardContext.java @@ -0,0 +1,84 @@ +/* + * 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.tuscany.sca.tomcat; + +import java.io.File; +import java.net.URL; +import java.net.URLClassLoader; + +import javax.naming.NamingException; + +import org.apache.catalina.Loader; +import org.apache.catalina.core.StandardContext; +import org.apache.catalina.deploy.FilterDef; + +public class TuscanyStandardContext extends StandardContext { + private static final long serialVersionUID = 1L; + + private ClassLoader tuscanyClassLoader; + + public Loader getLoader() { + if (loader != null) { + return loader; + } + + initTuscany(); + + return super.getLoader(); + } + + private void initTuscany() { + String scaVersion = getSCAVersion(); + if ("1.1".equals(scaVersion)) { + setParentClassLoader(getTuscanyClassloader(scaVersion)); + addApplicationListener("org.apache.tuscany.sca.host.webapp.TuscanyContextListener"); + FilterDef filterDef = new FilterDef(); + filterDef.setFilterName("TuscanyFilter"); + filterDef.setFilterClass("org.apache.tuscany.sca.host.webapp.TuscanyServletFilter"); + addFilterDef(filterDef); + } + } + + private String getSCAVersion() { + Object o = null; + try { + o = getResources().lookup("WEB-INF/web.composite"); + } catch (NamingException e) { + } + return o != null ? "1.1" : null; + } + + private ClassLoader getTuscanyClassloader(String version) { + if (tuscanyClassLoader == null) { + File tuscanyWar = new File(System.getProperty("org.apache.tuscany.sca.tomcat.war")); + File[] runtimeJars = new File(tuscanyWar, "tuscany-lib").listFiles(); + try { + URL[] jarURLs = new URL[runtimeJars.length]; + for (int i=0; i< jarURLs.length; i++) { + jarURLs[i] = runtimeJars[i].toURI().toURL(); + } + return new URLClassLoader(jarURLs, getParentClassLoader()); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + return tuscanyClassLoader; + } +} -- cgit v1.2.3