diff options
Diffstat (limited to 'sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host')
8 files changed, 1297 insertions, 0 deletions
diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyContextListener.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyContextListener.java new file mode 100644 index 0000000000..8959293d71 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyContextListener.java @@ -0,0 +1,62 @@ +/* + * 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.logging.Level; +import java.util.logging.Logger; + +import javax.servlet.ServletContextEvent; +import javax.servlet.ServletContextListener; + + +/** + * A ServletContextListener to create and close the SCADomain + * when the webapp is initialized or destroyed. + */ +public class TuscanyContextListener implements ServletContextListener { + private final Logger logger = Logger.getLogger(TuscanyContextListener.class.getName()); + private boolean inited; + + public void contextInitialized(ServletContextEvent event) { + logger.info(event.getServletContext().getServletContextName() + " is starting."); + try { + WebContextConfigurator configurator = WebAppHelper.getConfigurator(event.getServletContext()); + WebAppHelper.init(configurator); + } catch (Throwable e) { + logger.log(Level.SEVERE, e.getMessage(), e); + } + inited = true; + } + + public void contextDestroyed(ServletContextEvent event) { + logger.info(event.getServletContext().getServletContextName() + " is stopping."); + if (!inited) { + return; + } + try { + WebContextConfigurator configurator = WebAppHelper.getConfigurator(event.getServletContext()); + WebAppHelper.stop(configurator); + } catch (Throwable e) { + logger.log(Level.SEVERE, e.getMessage(), e); + } + inited = false; + } + +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServlet.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServlet.java new file mode 100644 index 0000000000..6da546d11a --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServlet.java @@ -0,0 +1,72 @@ +/* + * 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.logging.Level; +import java.util.logging.Logger; + +import javax.servlet.ServletConfig; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServlet; + +import org.apache.tuscany.sca.node.Node; + + +/** + * A Servlet that provides a hook to control the lifecycle of Tuscany node + * + * @version $Rev$ $Date$ + */ +public class TuscanyServlet extends HttpServlet { + private static final long serialVersionUID = 1L; + private Logger logger = Logger.getLogger(TuscanyServlet.class.getName()); + + private transient WebContextConfigurator configurator; + private transient Node node; + + public TuscanyServlet() { + super(); + } + + @Override + public void init(ServletConfig config) throws ServletException { + try { + super.init(config); + configurator = WebAppHelper.getConfigurator(this); + node = WebAppHelper.init(configurator); + } catch (Throwable e) { + logger.log(Level.SEVERE, e.getMessage(), e); + configurator.getServletContext().log(e.getMessage(), e); + throw new ServletException(e); + } + } + + public void destroy() { + WebAppHelper.stop(configurator); + node = null; + configurator = null; + super.destroy(); + } + + public Node getNode() { + return node; + } + +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java new file mode 100644 index 0000000000..f058e03788 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/TuscanyServletFilter.java @@ -0,0 +1,103 @@ +/* + * 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.logging.Level; +import java.util.logging.Logger; + +import javax.servlet.Filter; +import javax.servlet.FilterConfig; +import javax.servlet.RequestDispatcher; +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 Logger logger = Logger.getLogger(TuscanyServletFilter.class.getName()); + + private transient WebContextConfigurator configurator; + private transient ServletHost servletHost; + + public TuscanyServletFilter() { + super(); + } + + public void init(final FilterConfig config) throws ServletException { + try { + configurator = WebAppHelper.getConfigurator(config); + WebAppHelper.init(configurator); + servletHost = WebAppHelper.getServletHost(); + } catch (Throwable e) { + logger.log(Level.SEVERE, e.getMessage(), e); + configurator.getServletContext().log(e.getMessage(), e); + throw new ServletException(e); + } + } + + public void destroy() { + WebAppHelper.stop(configurator); + servletHost = null; + } + + public void doFilter(ServletRequest request, ServletResponse response, javax.servlet.FilterChain chain) + throws IOException, ServletException { + try { + // 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); + + } + } catch (Throwable e) { + logger.log(Level.SEVERE, e.getMessage(), e); + configurator.getServletContext().log(e.getMessage(), e); + throw new ServletException(e); + } + } + +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppContributionScanner.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppContributionScanner.java new file mode 100644 index 0000000000..835783612a --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppContributionScanner.java @@ -0,0 +1,83 @@ +/* + * 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.net.URI; +import java.net.URL; +import java.util.ArrayList; +import java.util.List; + +import javax.servlet.ServletContext; + +import org.apache.tuscany.sca.contribution.Artifact; +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.contribution.ContributionFactory; +import org.apache.tuscany.sca.contribution.PackageType; +import org.apache.tuscany.sca.contribution.processor.ContributionReadException; +import org.apache.tuscany.sca.contribution.scanner.ContributionScanner; +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.FactoryExtensionPoint; +import org.apache.tuscany.sca.core.UtilityExtensionPoint; + +/** + * + */ +public class WebAppContributionScanner implements ContributionScanner { + private ServletContext servletContext; + private ContributionFactory contributionFactory; + + public WebAppContributionScanner(ExtensionPointRegistry registry) { + super(); + this.servletContext = registry.getExtensionPoint(UtilityExtensionPoint.class).getUtility(ServletContext.class); + this.contributionFactory = + registry.getExtensionPoint(FactoryExtensionPoint.class).getFactory(ContributionFactory.class); + } + + public String getContributionType() { + return PackageType.WAR; + } + + public List<Artifact> scan(Contribution contribution) throws ContributionReadException { + try { + List<Artifact> artifacts = new ArrayList<Artifact>(); + URL location = new URL(contribution.getLocation()); + URL root = servletContext.getResource("/"); + URI relative = root.toURI().relativize(location.toURI()); + String path = relative.getPath(); + if (!path.startsWith("/")) { + path = "/" + path; + } + for (Object file : servletContext.getResourcePaths(path)) { + Artifact artifact = contributionFactory.createArtifact(); + String name = (String)file; + // Remove leading / + name = name.substring(1); + artifact.setURI(name); + URL artifactURL = new URL(location, name); + artifact.setLocation(artifactURL.toString()); + artifacts.add(artifact); + } + return artifacts; + } catch (Exception e) { + throw new ContributionReadException(e); + } + } + +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppHelper.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppHelper.java new file mode 100644 index 0000000000..231108bea2 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppHelper.java @@ -0,0 +1,475 @@ +/* + * 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.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.util.Enumeration; + +import javax.servlet.FilterConfig; +import javax.servlet.Servlet; +import javax.servlet.ServletConfig; +import javax.servlet.ServletContext; +import javax.servlet.ServletException; + +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.UtilityExtensionPoint; +import org.apache.tuscany.sca.host.http.ServletHostExtensionPoint; +import org.apache.tuscany.sca.node.Node; +import org.apache.tuscany.sca.node.NodeFactory; +import org.apache.tuscany.sca.node.configuration.NodeConfiguration; +import org.oasisopen.sca.ServiceRuntimeException; + +public class WebAppHelper { + private static final String ROOT = "/"; + // The prefix for the parameters in web.xml which configure the folders that contain SCA contributions + private static final String CONTRIBUTIONS = "contributions"; + private static final String DEFAULT_CONTRIBUTIONS = "/WEB-INF/sca-contributions"; + // The prefix for the parameters in web.xml which configure the individual SCA contributions + private static final String CONTRIBUTION = "contribution"; + private static final String NODE_CONFIGURATION = "node.configuration"; + private static final String DOMAIN_URI = "domain.uri"; + private static final String DOMAIN_REGISTRY_URI = "domain.registry.uri"; + private static final String NODE_URI = "node.uri"; + private static final String COMPOSITE_URI = "composite.uri"; + public static final String DOMAIN_NAME_ATTR = "org.apache.tuscany.sca.domain.name"; + public static final String DOMAIN_URI_PROP = "domainURI"; + public static final String SCA_NODE_ATTRIBUTE = Node.class.getName(); + private static NodeFactory factory; + private static WebAppServletHost host; + + private static URL getResource(ServletContext servletContext, String location) throws IOException { + URI uri = URI.create(location); + if (uri.isAbsolute()) { + return uri.toURL(); + } else { + String path = location; + if (!path.startsWith(ROOT)) { + path = ROOT + path; + } + URL url = servletContext.getResource(path); + if (url != null && url.getProtocol().equals("jndi")) { + //this is Tomcat case, we should use getRealPath + File warRootFile = new File(servletContext.getRealPath(path)); + return warRootFile.toURI().toURL(); + } else { + //this is Jetty case + return url; + } + } + } + + private static String[] parse(String listOfValues) { + if (listOfValues == null) { + return null; + } + return listOfValues.split("(\\s|,)+"); + } + + // TODO: Temp for now to get the old samples working till i clean up all the domain uri/name after the ML discussion. + private static String getDomainName(String configURI) { + String domainName; + if (configURI.startsWith("tuscany:vm:")) { + domainName = configURI.substring("tuscany:vm:".length()); + } else if (configURI.startsWith("uri:")) { + int i = configURI.indexOf('?'); + if (i == -1) { + domainName = configURI.substring("uri:".length()); + } else { + domainName = configURI.substring("uri:".length(), i); + } + } else { + domainName = configURI; + } + return domainName; + } + + public static WebAppServletHost getServletHost() { + return host; + } + + public static Node init(final WebContextConfigurator configurator) { + synchronized (configurator) { + + bootstrapRuntime(configurator); + Node node = (Node)configurator.getAttribute(SCA_NODE_ATTRIBUTE); + if (node == null) { + try { + node = createAndStartNode(configurator); + } catch (ServletException e) { + throw new ServiceRuntimeException(e); + } + configurator.setAttribute(SCA_NODE_ATTRIBUTE, node); + } + return node; + } + } + + /** + * Bootstrap the Tuscany runtime for the given scope + * @param configurator + */ + private synchronized static void bootstrapRuntime(final WebContextConfigurator configurator) { + if (host == null) { + try { + + String configValue = configurator.getInitParameter("org.apache.tuscany.sca.config"); + if (configValue != null) { + factory = NodeFactory.newInstance(configValue); + } else { + factory = NodeFactory.newInstance(); + } + + // Add ServletContext as a utility + ExtensionPointRegistry registry = factory.getExtensionPointRegistry(); + UtilityExtensionPoint utilityExtensionPoint = registry.getExtensionPoint(UtilityExtensionPoint.class); + utilityExtensionPoint.addUtility(ServletContext.class, configurator.getServletContext()); + + ServletHostExtensionPoint servletHosts = registry.getExtensionPoint(ServletHostExtensionPoint.class); + servletHosts.setWebApp(true); + + host = getServletHost(configurator); + + } catch (ServletException e) { + throw new ServiceRuntimeException(e); + } + } + } + + private static WebAppServletHost getServletHost(final WebContextConfigurator configurator) throws ServletException { + ExtensionPointRegistry registry = factory.getExtensionPointRegistry(); + WebAppServletHost host = + (WebAppServletHost)org.apache.tuscany.sca.host.http.ServletHostHelper.getServletHost(registry); + + host.init(new ServletConfig() { + public String getInitParameter(String name) { + return configurator.getInitParameter(name); + } + + public Enumeration<?> getInitParameterNames() { + return configurator.getInitParameterNames(); + } + + public ServletContext getServletContext() { + return configurator.getServletContext(); + } + + public String getServletName() { + return configurator.getServletContext().getServletContextName(); + } + }); + return host; + } + + private static Node createAndStartNode(final WebContextConfigurator configurator) throws ServletException { + NodeConfiguration configuration = null; + try { + configuration = getNodeConfiguration(configurator); + } catch (IOException e) { + throw new ServletException(e); + } catch (URISyntaxException e) { + throw new ServletException(e); + } + Node node = null; + if (configuration != null) { + node = factory.createNode(configuration).start(); + } + return node; + } + + public static void stop(WebContextConfigurator configurator) { + Node node = null; + if (configurator != null) { + node = (Node)configurator.getAttribute(SCA_NODE_ATTRIBUTE); + } + if (node != null) { + node.stop(); + configurator.setAttribute(SCA_NODE_ATTRIBUTE, null); + } + } + + public static void destroy() { + if (factory != null) { + factory.destroy(); + } + factory = null; + host = null; + } + + public static NodeFactory getNodeFactory() { + return factory; + } + + private static String getDefaultComposite(WebContextConfigurator configurator) { + String name = configurator.getName(); + if ("".equals(name)) { + return "/WEB-INF/web.composite"; + } else { + return "/WEB-INF/" + name + "/servlet.composite"; + } + } + + private static NodeConfiguration getNodeConfiguration(WebContextConfigurator configurator) throws IOException, + URISyntaxException { + NodeConfiguration configuration = null; + String nodeConfigURI = configurator.getInitParameter(NODE_CONFIGURATION); + ServletContext servletContext = configurator.getServletContext(); + if (nodeConfigURI != null) { + URL url = getResource(servletContext, nodeConfigURI); + configuration = factory.loadConfiguration(url.openStream(), url); + } else { + configuration = factory.createNodeConfiguration(); + + boolean explicitContributions = false; + Enumeration<String> names = configurator.getInitParameterNames(); + while (names.hasMoreElements()) { + String name = names.nextElement(); + if (name.equals(CONTRIBUTION) || name.startsWith(CONTRIBUTION + ".")) { + explicitContributions = true; + // We need to have a way to select one or more folders within the webapp as the contributions + String listOfValues = configurator.getInitParameter(name); + if (listOfValues != null) { + for (String path : parse(listOfValues)) { + if ("".equals(path)) { + continue; + } + File f = new File(getResource(servletContext, path).toURI()); + configuration.addContribution(f.toURI().toURL()); + } + } + } else if (name.equals(CONTRIBUTIONS) || name.startsWith(CONTRIBUTIONS + ".")) { + explicitContributions = true; + String listOfValues = (String)configurator.getInitParameter(name); + if (listOfValues != null) { + for (String path : parse(listOfValues)) { + if ("".equals(path)) { + continue; + } + File f = new File(getResource(servletContext, path).toURI()); + if (f.isDirectory()) { + for (File n : f.listFiles()) { + configuration.addContribution(n.toURI().toURL()); + } + } else { + configuration.addContribution(f.toURI().toURL()); + } + } + } + } + } + + String compositeURI = configurator.getInitParameter(COMPOSITE_URI); + if (compositeURI == null) { + compositeURI = getDefaultComposite(configurator); + } + URL composite = getResource(servletContext, compositeURI); + if (configuration.getContributions().isEmpty() || (!explicitContributions && composite != null)) { + if ("".equals(configurator.getName())) { + // Add the root of the web application + configuration.addContribution(getResource(servletContext, ROOT)); + } else { + // Add a dummy contribution + configuration.addContribution(URI.create("sca:contributions/" + configurator.getName()), null); + } + } + if (composite != null) { + configuration.getContributions().get(0).addDeploymentComposite(composite); + } + if (!explicitContributions) { + URL url = getResource(servletContext, DEFAULT_CONTRIBUTIONS); + if (url != null) { + File f = new File(url.toURI()); + if (f.isDirectory()) { + for (File n : f.listFiles()) { + configuration.addContribution(n.toURI().toURL()); + } + } + } + } + String nodeURI = configurator.getInitParameter(NODE_URI); + if (nodeURI == null) { + nodeURI = getResource(servletContext, ROOT).getPath() + configurator.getName(); + } + configuration.setURI(nodeURI); + String domainURI = configurator.getInitParameter(DOMAIN_URI); + if (domainURI != null) { + configuration.setDomainURI(domainURI); + } else { + domainURI = configurator.getInitParameter("org.apache.tuscany.sca.defaultDomainURI"); + if (domainURI == null) { + domainURI = System.getProperty(DOMAIN_URI_PROP); + } + if (domainURI != null) { + configuration.setDomainURI(getDomainName(domainURI)); + configuration.setDomainRegistryURI(domainURI); + } + } + String domainRegistryURI = configurator.getInitParameter(DOMAIN_REGISTRY_URI); + if (domainRegistryURI != null) { + configuration.setDomainRegistryURI(domainRegistryURI); + } + } + configuration.setAttribute(ServletContext.class.getName(), servletContext); + if(configurator instanceof ServletConfigurator) { + configuration.setAttribute(Servlet.class.getName(), ((ServletConfigurator) configurator).servlet); + } + return configuration; + } + + public static WebContextConfigurator getConfigurator(FilterConfig config) { + return new FilterConfigurator(config); + } + + public static WebContextConfigurator getConfigurator(ServletContext context) { + return new ServletContextConfigurator(context); + } + + public static WebContextConfigurator getConfigurator(Servlet context) { + return new ServletConfigurator(context); + } + + public static class FilterConfigurator implements WebContextConfigurator { + private FilterConfig config; + + public FilterConfigurator(FilterConfig config) { + super(); + this.config = config; + } + + public String getInitParameter(String name) { + String value = config.getInitParameter(name); + if (value == null) { + return config.getServletContext().getInitParameter(name); + } else { + return value; + } + } + + public Enumeration<String> getInitParameterNames() { + Enumeration<String> names = config.getInitParameterNames(); + if (!names.hasMoreElements()) { + return getServletContext().getInitParameterNames(); + } else { + return names; + } + } + + public ServletContext getServletContext() { + return config.getServletContext(); + } + + public void setAttribute(String name, Object value) { + String prefix = "filter:" + config.getFilterName() + ":"; + getServletContext().setAttribute(prefix + name, value); + } + + public <T> T getAttribute(String name) { + String prefix = "filter:" + config.getFilterName() + ":"; + return (T)getServletContext().getAttribute(prefix + name); + } + + public String getName() { + return ""; + } + + } + + public static class ServletContextConfigurator implements WebContextConfigurator { + private ServletContext context; + + public ServletContextConfigurator(ServletContext context) { + super(); + this.context = context; + } + + public String getInitParameter(String name) { + return context.getInitParameter(name); + } + + public Enumeration<String> getInitParameterNames() { + return context.getInitParameterNames(); + } + + public ServletContext getServletContext() { + return context; + } + + public void setAttribute(String name, Object value) { + context.setAttribute(name, value); + } + + public <T> T getAttribute(String name) { + return (T)context.getAttribute(name); + } + + public String getName() { + return ""; + } + } + + public static class ServletConfigurator implements WebContextConfigurator { + private ServletConfig config; + private Servlet servlet; + + public ServletConfigurator(Servlet servlet) { + super(); + this.servlet = servlet; + this.config = servlet.getServletConfig(); + } + + public String getInitParameter(String name) { + String value = config.getInitParameter(name); + return value; + /* + if (value == null) { + return config.getServletContext().getInitParameter(name); + } else { + return value; + } + */ + } + + public Enumeration<String> getInitParameterNames() { + return config.getInitParameterNames(); + } + + public ServletContext getServletContext() { + return config.getServletContext(); + } + + public void setAttribute(String name, Object value) { + String prefix = "servlet:" + config.getServletName() + ":"; + getServletContext().setAttribute(prefix + name, value); + } + + public <T> T getAttribute(String name) { + String prefix = "servlet:" + config.getServletName() + ":"; + return (T)getServletContext().getAttribute(prefix + name); + } + + public String getName() { + return config.getServletName(); + } + + } +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java new file mode 100644 index 0000000000..76cce939ad --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppRequestDispatcher.java @@ -0,0 +1,117 @@ +/* + * 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) { + if (path.startsWith(servletPath)) { + return path.substring(servletPath.length()); + } + 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/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java new file mode 100644 index 0000000000..fed2f67893 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebAppServletHost.java @@ -0,0 +1,345 @@ +/* + * 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.lang.reflect.Method; +import java.net.InetAddress; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URL; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.logging.Level; +import java.util.logging.Logger; + +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.SecurityContext; +import org.apache.tuscany.sca.host.http.ServletHost; +import org.apache.tuscany.sca.host.http.ServletMappingException; +import org.apache.tuscany.sca.node.Node; + +/** + * ServletHost implementation for use in a webapp environment. + * + * @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 Map<String, Servlet> servlets; + private String contextPath = "/"; + private int defaultPortNumber = 8080; + private String contributionRoot; + + private ServletConfig servletConfig; + private ServletContext servletContext; + private Map<String, Object> tempAttributes = new HashMap<String, Object>(); + + public WebAppServletHost() { + servlets = new HashMap<String, Servlet>(); + } + + public void setDefaultPort(int port) { + defaultPortNumber = port; + } + + public int getDefaultPort() { + return defaultPortNumber; + } + + public String getName() { + return "webapp"; + } + + public String addServletMapping(String suri, Servlet servlet) throws ServletMappingException { + return addServletMapping(suri, servlet, null); + } + + public String addServletMapping(String suri, Servlet servlet, SecurityContext securityContext) throws ServletMappingException { + URI pathURI = URI.create(suri); + + // Make sure that the path starts with a / + suri = pathURI.getPath(); + if (!suri.startsWith("/")) { + suri = '/' + suri; + } + + // String relativeURI = suri; + if (!suri.startsWith(contextPath + "/")) { + suri = contextPath + suri; + } + + if (!servlets.values().contains(servlet)) { + // The same servlet can be registred more than once + try { + servlet.init(servletConfig); + } catch (ServletException e) { + throw new ServletMappingException(e); + } + } + + // 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); + + URL url = getURLMapping(pathURI.toString(), securityContext); + logger.info("Added Servlet mapping: " + url); + return url.toString(); + } + + 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 + Servlet servlet = servlets.remove(suri); + /* + if (servlet != null) { + servlet.destroy(); + } + */ + return servlet; + } + + 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, SecurityContext securityContext) 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 && uri.getScheme() == null) { + // Only set the default port number if the scheme is not present + portNumber = defaultPortNumber; + } + + // Get the host + String host = uri.getHost(); + if (host == null) { + try { + //TUSCANY-3667 - InetAddress is not allowed in GoogleAppEngine + host = InetAddress.getLocalHost().getHostName(); + } catch (Throwable t) { + logger.log(Level.WARNING, "Error retrieving host information : " + t.getMessage()); + 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; + } + + if (contextPath != null && contextPath.length() > 0 && !"/".equals(contextPath)) { + 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 void init(ServletConfig config) throws ServletException { + this.servletConfig = config; + servletContext = config.getServletContext(); + + for (String name : tempAttributes.keySet()) { + servletContext.setAttribute(name, tempAttributes.get(name)); + } + + // WebAppHelper.init(servletContext); + + initContextPath(config); + + // Initialize the registered Servlets + for (Servlet servlet : servlets.values()) { + servlet.init(config); + } + + } + + /** + * 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) { + + String oldContextPath = contextPath; + + 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); + + // if the context path changes after some servlets have been registered then + // need to reregister them (this can happen if extensions start before webapp init) + if (!oldContextPath.endsWith(contextPath)) { + List<String> oldServletURIs = new ArrayList<String>(); + for (String oldServletURI : servlets.keySet()) { + if (oldServletURI.startsWith(oldContextPath)) { + if (!oldServletURI.startsWith(contextPath)) { + oldServletURIs.add(oldServletURI); + } + } + } + for (String oldURI : oldServletURIs) { + String ns = contextPath + "/" + oldURI.substring(oldContextPath.length()); + servlets.put(ns, servlets.remove(oldURI)); + } + } + + } + + void destroy() { + + // Destroy the registered Servlets + for (Servlet servlet : servlets.values()) { + servlet.destroy(); + } + + // Close the SCA domain + WebAppHelper.destroy(); + } + + public String getContextPath() { + return contextPath; + } + + public void setContextPath(String 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) { + if (servletContext != null) { + servletContext.setAttribute(name, value); + } else { + tempAttributes.put(name, value); + } + } + + public ServletContext getServletContext() { + return servletContext; + } +} diff --git a/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebContextConfigurator.java b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebContextConfigurator.java new file mode 100644 index 0000000000..e1879c8f33 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1-RC1/modules/host-webapp/src/main/java/org/apache/tuscany/sca/host/webapp/WebContextConfigurator.java @@ -0,0 +1,40 @@ +/* + * 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.Enumeration; + +import javax.servlet.ServletContext; + +/** + * The interface that represents a given scope (Webapp vs Servlet) that provides the configuration of the Tuscany node + */ +public interface WebContextConfigurator { + String getInitParameter(String name); + + Enumeration<String> getInitParameterNames(); + + ServletContext getServletContext(); + + void setAttribute(String name, Object value); + + <T> T getAttribute(String name); + + String getName(); +}
\ No newline at end of file |