diff options
author | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2008-11-19 00:10:54 +0000 |
---|---|---|
committer | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2008-11-19 00:10:54 +0000 |
commit | 60744a36aae604ac3c4499ed54f1082ab8f5947d (patch) | |
tree | e31d312659c912cdf29ef7a677406795fe5b3726 /java/sca/modules/host-webapp | |
parent | ad1c9458ea08eb593be252b706a88568f17c494c (diff) |
Copying modules from Equinox branch, to start merging the delta changes from 1.x/original trunk
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@718815 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'java/sca/modules/host-webapp')
12 files changed, 1183 insertions, 0 deletions
diff --git a/java/sca/modules/host-webapp/LICENSE b/java/sca/modules/host-webapp/LICENSE new file mode 100644 index 0000000000..8aa906c321 --- /dev/null +++ b/java/sca/modules/host-webapp/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/modules/host-webapp/META-INF/MANIFEST.MF b/java/sca/modules/host-webapp/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..978516584a --- /dev/null +++ b/java/sca/modules/host-webapp/META-INF/MANIFEST.MF @@ -0,0 +1,31 @@ +Manifest-Version: 1.0
+Export-Package: org.apache.tuscany.sca.host.webapp.jsp;uses:="javax.se
+ rvlet,org.apache.tuscany.sca.host.embedded,javax.servlet.jsp.tagext,o
+ rg.apache.tuscany.sca.host.webapp,org.osoa.sca,javax.servlet.jsp";ver
+ sion="1.4",org.apache.tuscany.sca.host.webapp;uses:="javax.naming,org
+ .apache.tuscany.sca.host.embedded.impl,org.apache.tuscany.sca.host.em
+ bedded,org.apache.tuscany.sca.core,javax.servlet,org.apache.tuscany.s
+ ca.host.http,javax.servlet.http";version="1.4"
+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: 1.4
+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,
+ javax.servlet.jsp,
+ javax.servlet.jsp.tagext,
+ org.apache.tuscany.sca.core;version="1.4",
+ org.apache.tuscany.sca.host.http;version="1.4",
+ org.apache.tuscany.sca.host.webapp;version="1.4",
+ org.apache.tuscany.sca.host.webapp.jsp;version="1.4",
+ org.apache.tuscany.sca.node;version="1.4.0",
+ org.osoa.sca;version="1.4"
+Bundle-SymbolicName: org.apache.tuscany.sca.host.webapp
+Bundle-DocURL: http://www.apache.org/
+
diff --git a/java/sca/modules/host-webapp/NOTICE b/java/sca/modules/host-webapp/NOTICE new file mode 100644 index 0000000000..fdfa0e9faa --- /dev/null +++ b/java/sca/modules/host-webapp/NOTICE @@ -0,0 +1,6 @@ +${pom.name} +Copyright (c) 2005 - 2008 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + diff --git a/java/sca/modules/host-webapp/pom.xml b/java/sca/modules/host-webapp/pom.xml new file mode 100644 index 0000000000..4c30161f04 --- /dev/null +++ b/java/sca/modules/host-webapp/pom.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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. +--> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-modules</artifactId> + <version>1.4-EQUINOX-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>tuscany-host-webapp</artifactId> + <name>Apache Tuscany SCA Webapp Host</name> + + <dependencies> + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-contribution</artifactId> + <version>1.4-EQUINOX-SNAPSHOT</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-host-http</artifactId> + <version>1.4-EQUINOX-SNAPSHOT</version> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-node-api</artifactId> + <version>1.4-EQUINOX-SNAPSHOT</version> + <scope>compile</scope> + </dependency> + + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-node-impl</artifactId> + <version>1.4-EQUINOX-SNAPSHOT</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>javax.servlet</groupId> + <artifactId>servlet-api</artifactId> + <version>2.5</version> + </dependency> + + <dependency> + <groupId>org.apache.geronimo.specs</groupId> + <artifactId>geronimo-jsp_2.1_spec</artifactId> + <version>1.0</version> + <scope>provided</scope> + </dependency> + + </dependencies> + +</project> diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java new file mode 100644 index 0000000000..cb4369fc01 --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java @@ -0,0 +1,122 @@ +/* + * 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.host.webapp; + +import java.io.IOException; +import java.util.Collections; +import java.util.Enumeration; +import java.util.Map; +import java.util.WeakHashMap; + +import javax.servlet.Filter; +import javax.servlet.FilterConfig; +import javax.servlet.RequestDispatcher; +import javax.servlet.ServletConfig; +import javax.servlet.ServletContext; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletRequest; + +import org.apache.tuscany.sca.host.http.ServletHost; + +/** + * A Servlet filter that forwards service requests to the Servlets registered with + * the Tuscany ServletHost. + * + * @version $Rev$ $Date$ + */ +public class TuscanyServletFilter implements Filter { + private static final long serialVersionUID = 1L; + //private static final Logger logger = Logger.getLogger(WebAppServletHost.class.getName()); + + private static Map<ClassLoader, ServletHost> servletHosts = + Collections.synchronizedMap(new WeakHashMap<ClassLoader, ServletHost>()); + + // [REVIEW] Assume the filter class is per webapp + private static WebAppServletHost servletHost; + + // Test if the servletHost == null to know if the filter is called (webapp) + static ServletHost getServletHost() { + return servletHosts.get(Thread.currentThread().getContextClassLoader()); + } + + public void init(final FilterConfig config) throws ServletException { + // TODO: must be a better way to get this than using a static + servletHost = new WebAppServletHost(); + servletHosts.put(Thread.currentThread().getContextClassLoader(), servletHost); + + // Initialize the Servlet host + servletHost.init(new ServletConfig() { + public String getInitParameter(String name) { + return config.getInitParameter(name); + } + + public Enumeration getInitParameterNames() { + return config.getInitParameterNames(); + } + + public ServletContext getServletContext() { + return config.getServletContext(); + } + + public String getServletName() { + return config.getFilterName(); + } + }); + } + + public void destroy() { + if (servletHost != null) { + servletHost.destroy(); + servletHost = null; + servletHosts.remove(Thread.currentThread().getContextClassLoader()); + } + } + + public void doFilter(ServletRequest request, ServletResponse response, javax.servlet.FilterChain chain) + throws IOException, ServletException { + + // Get the Servlet path + HttpServletRequest httpRequest = (HttpServletRequest)request; + String path = httpRequest.getPathInfo(); + if (path == null) { + path = httpRequest.getServletPath(); + } + if (path == null) { + path = "/"; + } + + // Get a request dispatcher for the Servlet mapped to that path + RequestDispatcher dispatcher = servletHost.getRequestDispatcher(path); + if (dispatcher != null) { + + // Let the dispatcher forward the request to the Servlet + dispatcher.forward(request, response); + + } else { + + // Proceed down the filter chain + chain.doFilter(request, response); + + } + } + +} diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java new file mode 100644 index 0000000000..88caa33f2a --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.java @@ -0,0 +1,52 @@ +/* + * 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.host.webapp; + +import java.util.List; + +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.ModuleActivator; +import org.apache.tuscany.sca.host.http.ServletHost; +import org.apache.tuscany.sca.host.http.ServletHostExtensionPoint; + +/** + * Activates the webapp host by registering the webapp ServletHost impl + * + * @version $Rev$ $Date$ + */ +public class WebAppModuleActivator implements ModuleActivator { + + public void start(ExtensionPointRegistry extensionPointRegistry) { + + ServletHostExtensionPoint servletHosts = + extensionPointRegistry.getExtensionPoint(ServletHostExtensionPoint.class); + + List<ServletHost> hosts = servletHosts.getServletHosts(); + ServletHost host = TuscanyServletFilter.getServletHost(); + if (host != null) { + hosts.clear(); + hosts.add(host); + } + } + + public void stop(ExtensionPointRegistry registry) { + } + +} diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java new file mode 100644 index 0000000000..f14dfac58b --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java @@ -0,0 +1,114 @@ +/* + * 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.host.webapp; + +import java.io.IOException; +import java.util.StringTokenizer; + +import javax.servlet.RequestDispatcher; +import javax.servlet.Servlet; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletRequestWrapper; + +/** + * A Servlet request dispatcher that can be used to delegate requests to a + * Servlet registered with the Webapp Servlet host. + * + * @version $Rev$ $Date$ + */ +class WebAppRequestDispatcher implements RequestDispatcher { + private String servletPath; + private Servlet servlet; + + public WebAppRequestDispatcher(String mapping, Servlet servlet) { + if (mapping.endsWith("*")) { + mapping = mapping.substring(0, mapping.length()-1); + } + if (mapping.endsWith("/")) { + mapping = mapping.substring(0, mapping.length()-1); + } + this.servletPath = mapping; + this.servlet = servlet; + } + + /** + * Returns a request wrapper which will return the correct Servlet path + * and path info. + * + * @param request + * @return + */ + private HttpServletRequest createRequestWrapper(ServletRequest request) { + HttpServletRequest requestWrapper = new HttpServletRequestWrapper((HttpServletRequest)request) { + + @Override + public String getServletPath() { + return servletPath; + } + + @Override + public String getPathInfo() { + String path = super.getServletPath(); + if (path.length() == 0) { + path = super.getPathInfo(); + } + + // TODO: another context path hack, revisit when context path is sorted out + path = fiddlePath(path, servletPath); + + return path; + } + }; + return requestWrapper; + } + + /** + * Remove any path suffix thats part of the Servlet context path + */ + protected String fiddlePath(String path, String servletPath) { + StringTokenizer st = new StringTokenizer(path, "/"); + if (st.countTokens() == 1) { + return path; + } + String root = ""; + while (st.hasMoreTokens()){ + String s = st.nextToken(); + if (servletPath.endsWith((root + "/" + s))) { + root += "/" + s; + } else { + break; + } + } + String fiddlePath = path.substring(root.length()); + return fiddlePath; + } + + public void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException { + servlet.service(createRequestWrapper(request), response); + } + + public void include(ServletRequest request, ServletResponse response) throws ServletException, IOException { + servlet.service(createRequestWrapper(request), response); + } +} + diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java new file mode 100644 index 0000000000..729810b0fb --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java @@ -0,0 +1,336 @@ +/* + * 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.host.webapp; + +import java.io.File; +import java.lang.reflect.Method; +import java.net.InetAddress; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URL; +import java.net.UnknownHostException; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.logging.Logger; + +import javax.naming.InitialContext; +import javax.naming.NamingException; +import javax.servlet.RequestDispatcher; +import javax.servlet.Servlet; +import javax.servlet.ServletConfig; +import javax.servlet.ServletContext; +import javax.servlet.ServletException; + +import org.apache.tuscany.sca.host.http.ServletHost; +import org.apache.tuscany.sca.host.http.ServletMappingException; +import org.apache.tuscany.sca.node.Contribution; +import org.apache.tuscany.sca.node.Node; +import org.apache.tuscany.sca.node.NodeFactory; + +/** + * ServletHost implementation for use in a webapp environment. + * + * FIXME: using a static singleton seems a big hack but how should it be shared? + * Need some way for TuscanyServlet to pull it out. + * + * @version $Rev$ $Date$ + */ +public class WebAppServletHost implements ServletHost { + private static final Logger logger = Logger.getLogger(WebAppServletHost.class.getName()); + + public static final String SCA_NODE_ATTRIBUTE = Node.class.getName(); + + private static final WebAppServletHost instance = new WebAppServletHost(); + + private Map<String, Servlet> servlets; + private Node node; + private String contextPath = "/"; + private int defaultPortNumber = 8080; + private String contributionRoot; + + private ServletContext servletContext; + + WebAppServletHost() { + servlets = new HashMap<String, Servlet>(); + } + + public void setDefaultPort(int port) { + defaultPortNumber = port; + } + + public int getDefaultPort() { + return defaultPortNumber; + } + + public void addServletMapping(String suri, Servlet servlet) throws ServletMappingException { + URI pathURI = URI.create(suri); + + // Make sure that the path starts with a / + suri = pathURI.getPath(); + if (!suri.startsWith("/")) { + suri = '/' + suri; + } + + if (!suri.startsWith(contextPath)) { + suri = contextPath + suri; + } + + // In a webapp just use the given path and ignore the host and port + // as they are fixed by the Web container + servlets.put(suri, servlet); + + logger.info("Added Servlet mapping: " + suri); + } + + public Servlet removeServletMapping(String suri) throws ServletMappingException { + URI pathURI = URI.create(suri); + + // Make sure that the path starts with a / + suri = pathURI.getPath(); + if (!suri.startsWith("/")) { + suri = '/' + suri; + } + + if (!suri.startsWith(contextPath)) { + suri = contextPath + suri; + } + + // In a webapp just use the given path and ignore the host and port + // as they are fixed by the Web container + return servlets.remove(suri); + } + + public Servlet getServletMapping(String suri) throws ServletMappingException { + if (!suri.startsWith("/")) { + suri = '/' + suri; + } + + if (!suri.startsWith(contextPath)) { + suri = contextPath + suri; + } + + // Get the Servlet mapped to the given path + Servlet servlet = servlets.get(suri); + return servlet; + } + + public URL getURLMapping(String suri) throws ServletMappingException { + URI uri = URI.create(suri); + + // Get the URI scheme and port + String scheme = uri.getScheme(); + if (scheme == null) { + scheme = "http"; + } + int portNumber = uri.getPort(); + if (portNumber == -1) { + portNumber = defaultPortNumber; + } + + // Get the host + String host; + try { + host = InetAddress.getLocalHost().getHostName(); + } catch (UnknownHostException e) { + host = "localhost"; + } + + // Construct the URL + String path = uri.getPath(); + if (!path.startsWith("/")) { + path = '/' + path; + } + + if (contextPath != null && !path.startsWith(contextPath)) { + path = contextPath + path; + } + + URL url; + try { + url = new URL(scheme, host, portNumber, path); + } catch (MalformedURLException e) { + throw new ServletMappingException(e); + } + return url; + } + + public RequestDispatcher getRequestDispatcher(String suri) throws ServletMappingException { + + // Make sure that the path starts with a / + if (!suri.startsWith("/")) { + suri = '/' + suri; + } + + suri = contextPath + suri; + + // Get the Servlet mapped to the given path + Servlet servlet = servlets.get(suri); + if (servlet != null) { + return new WebAppRequestDispatcher(suri, servlet); + } + + for (Map.Entry<String, Servlet> entry : servlets.entrySet()) { + String servletPath = entry.getKey(); + if (servletPath.endsWith("*")) { + servletPath = servletPath.substring(0, servletPath.length() - 1); + if (suri.startsWith(servletPath)) { + // entry key is contextPath/servletPath, WebAppRequestDispatcher only wants servletPath + return new WebAppRequestDispatcher(entry.getKey().substring(contextPath.length()), entry.getValue()); + } else { + if ((suri + "/").startsWith(servletPath)) { + return new WebAppRequestDispatcher(entry.getKey().substring(contextPath.length()), entry.getValue()); + } + } + } + } + + // No Servlet found + return null; + } + + public static WebAppServletHost getInstance() { + return instance; + } + + public void init(ServletConfig config) throws ServletException { + + servletContext = config.getServletContext(); + if (servletContext.getAttribute(SCA_NODE_ATTRIBUTE) == null) { + initContextPath(config); + contributionRoot = getContributionRoot(servletContext); + NodeFactory factory = NodeFactory.newInstance(); + node = factory.createNode(null, new Contribution(contributionRoot, contributionRoot)); + node.start(); + servletContext.setAttribute(SCA_NODE_ATTRIBUTE, node); + } + + // Initialize the registered Servlets + for (Servlet servlet : servlets.values()) { + servlet.init(config); + } + + } + + protected String getContributionRoot(ServletContext servletContext) { + String contributionRoot = null; + try { + + InitialContext ic = new InitialContext(); + URL repoURL = (URL)ic.lookup("java:comp/env/url/contributions"); + + contributionRoot = repoURL.toString(); + + } catch (NamingException e) { + + // ignore exception and use default location + + try { + + String root = servletContext.getInitParameter("contributionRoot"); + if (root == null || root.length() < 1) { + root = "/"; + } + URL rootURL = servletContext.getResource(root); + if (rootURL.getProtocol().equals("jndi")) { + //this is Tomcat case, we should use getRealPath + File warRootFile = new File(servletContext.getRealPath(root)); + contributionRoot = warRootFile.toURI().toString(); + } else { + //this is Jetty case + contributionRoot = rootURL.toString(); + } + + } catch (MalformedURLException mf) { + //ignore, pass null + } + } + + return contributionRoot; + } + + /** + * Initializes the contextPath + * The 2.5 Servlet API has a getter for this, for pre 2.5 Servlet + * containers use an init parameter. + */ + @SuppressWarnings("unchecked") + public void initContextPath(ServletConfig config) { + + if (Collections.list(config.getInitParameterNames()).contains("contextPath")) { + contextPath = config.getInitParameter("contextPath"); + } else { + // The getContextPath() is introduced since Servlet 2.5 + ServletContext context = config.getServletContext(); + try { + // Try to get the method anyway since some ServletContext impl has this method even before 2.5 + Method m = context.getClass().getMethod("getContextPath", new Class[] {}); + contextPath = (String)m.invoke(context, new Object[] {}); + } catch (Exception e) { + logger.warning("Servlet level is: " + context.getMajorVersion() + "." + context.getMinorVersion()); + throw new IllegalStateException("'contextPath' init parameter must be set for pre-2.5 servlet container"); + } + } + + logger.info("ContextPath: " + contextPath); + } + + void destroy() { + + // Destroy the registered Servlets + for (Servlet servlet : servlets.values()) { + servlet.destroy(); + } + + // Close the SCA domain + if (node != null) { + node.stop(); + } + } + + public String getContextPath() { + return contextPath; + } + + public void setContextPath(String path) { + // if (!contextPath.equals(path)) { + // throw new IllegalArgumentException("invalid context path for webapp, existing context path: " + contextPath + " new contextPath: " + path); + // } + } + + /** + * TODO: How context paths work is still up in the air so for now + * this hacks in a path that gets some samples working + * can't use setContextPath as NodeImpl calls that later + */ + public void setContextPath2(String path) { + if (path != null && path.length() > 0) { + this.contextPath = path; + } + } + + public String getContributionRoot() { + return contributionRoot; + } + + public void setAttribute(String name, Object value) { + servletContext.setAttribute(name, value); + } +} diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTEI.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTEI.java new file mode 100644 index 0000000000..6e1b187a48 --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTEI.java @@ -0,0 +1,45 @@ +/* + * 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.host.webapp.jsp; + +import javax.servlet.jsp.tagext.TagData; +import javax.servlet.jsp.tagext.TagExtraInfo; +import javax.servlet.jsp.tagext.VariableInfo; + +/** + * TagExtraInfo class for the SCA reference tags + * <sca:reference name="service" type="test.MyService" scope="1" /> + * + * @version $Rev$ $Date$ + */ +public class ReferenceTEI extends TagExtraInfo { + + @Override + public VariableInfo[] getVariableInfo(TagData data) { + VariableInfo info1 + = new VariableInfo( + data.getAttributeString("name"), + data.getAttributeString("type"), + true, + VariableInfo.AT_END); + VariableInfo[] info = { info1 } ; + return info; + } +} diff --git a/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTag.java b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTag.java new file mode 100644 index 0000000000..704f45b706 --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/jsp/ReferenceTag.java @@ -0,0 +1,118 @@ +/* + * 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.host.webapp.jsp; + +import javax.servlet.ServletContext; +import javax.servlet.ServletException; +import javax.servlet.jsp.JspException; +import javax.servlet.jsp.PageContext; +import javax.servlet.jsp.tagext.TagSupport; + +import org.apache.tuscany.sca.host.webapp.WebAppServletHost; +import org.apache.tuscany.sca.node.Node; +import org.osoa.sca.ComponentContext; + +/** + * Tag to handle SCA references + * <sca:reference name="service" type="test.MyService" scope="1" /> + * + * @version $Rev$ $Date$ + */ +public class ReferenceTag extends TagSupport { + private static final long serialVersionUID = 1L; + + protected String name; + protected String type; + protected Integer scope = PageContext.PAGE_SCOPE; + + @Override + public int doStartTag() throws JspException { + return SKIP_BODY; + } + + @Override + public int doEndTag() throws JspException { + + try { + WebAppServletHost.getInstance().init(pageContext.getServletConfig()); + } catch (ServletException e) { + throw new JspException("Exception initializing Tuscany webapp: " + e, e); + } + + ServletContext servletContext = pageContext.getServletContext(); + ComponentContext componentContext = (ComponentContext)servletContext.getAttribute("org.osoa.sca.ComponentContext"); + Node scaDomain = null; + if (componentContext == null) { + scaDomain = (Node)servletContext.getAttribute(WebAppServletHost.SCA_NODE_ATTRIBUTE); + if (scaDomain == null) { + throw new JspException("SCADomain is null. Check Tuscany configuration in web.xml"); + } + } + + Class<?> typeClass; + try { + typeClass = Class.forName(type, true, Thread.currentThread().getContextClassLoader()); + } catch (ClassNotFoundException e) { + throw new JspException("Reference '" + name + "' type class not found: " + type); + } + + Object o; + try { + if (componentContext != null) { + o = componentContext.getService(typeClass, name); + } else { + o = scaDomain.getService(typeClass, name); + } + } catch (Exception e) { + throw new JspException("Exception getting service for reference'" + name + "': " + e, e); + } + if (o == null) { + throw new JspException("Reference '" + name + "' not found"); + } + + pageContext.setAttribute(name, o, scope); + + return EVAL_PAGE; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Integer getScope() { + return scope; + } + + public void setScope(Integer scope) { + this.scope = scope; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } +} diff --git a/java/sca/modules/host-webapp/src/main/resources/META-INF/sca.tld b/java/sca/modules/host-webapp/src/main/resources/META-INF/sca.tld new file mode 100644 index 0000000000..089cdc1607 --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/resources/META-INF/sca.tld @@ -0,0 +1,62 @@ +<?xml version = '1.0' encoding = 'ISO-8859-1'?>
+<!--
+ * 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.
+ -->
+
+<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd">
+
+<taglib version="2.1">
+
+ <tlib-version>1.0</tlib-version>
+ <short-name>SCA-JSP</short-name>
+ <uri>http://www.osoa.org/sca/sca_jsp.tld</uri>
+ <description>A tag library for integrating sca components with jsp</description>
+
+ <tag>
+
+ <name>reference</name>
+
+ <tag-class>org.apache.tuscany.sca.host.webapp.jsp.ReferenceTag</tag-class>
+ <tei-class>org.apache.tuscany.sca.host.webapp.jsp.ReferenceTEI</tei-class>
+
+ <attribute>
+ <name>name</name>
+ <required>true</required>
+ <rtexprvalue>false</rtexprvalue>
+ <type>java.lang.String</type>
+ </attribute>
+
+ <attribute>
+ <name>type</name>
+ <required>true</required>
+ <rtexprvalue>false</rtexprvalue>
+ <type>java.lang.String</type>
+ </attribute>
+
+ <attribute>
+ <name>scope</name>
+ <required>false</required>
+ <rtexprvalue>false</rtexprvalue>
+ <type>java.lang.Integer</type>
+ </attribute>
+
+ <body-content>empty</body-content>
+
+ </tag>
+
+</taglib>
diff --git a/java/sca/modules/host-webapp/src/main/resources/META-INF/services/org.apache.tuscany.sca.core.ModuleActivator b/java/sca/modules/host-webapp/src/main/resources/META-INF/services/org.apache.tuscany.sca.core.ModuleActivator new file mode 100644 index 0000000000..d99fdf257e --- /dev/null +++ b/java/sca/modules/host-webapp/src/main/resources/META-INF/services/org.apache.tuscany.sca.core.ModuleActivator @@ -0,0 +1,18 @@ +# 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.
+# Implementation class for the ModuleActivator
+org.apache.tuscany.sca.host.webapp.WebAppModuleActivator
|