Author: thomas.diesler(a)jboss.com Date: 2006-12-21 09:40:46 -0500 (Thu, 21 Dec 2006) New Revision: 1697 Added: branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/AbstractServiceEndpointPublisher.java Removed: branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java Log: partial commit Copied: branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/AbstractServiceEndpointPublisher.java (from rev 1685, branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java) =================================================================== --- branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java 2006-12-21 12:54:28 UTC (rev 1685) +++ branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/AbstractServiceEndpointPublisher.java 2006-12-21 14:40:46 UTC (rev 1697) @@ -0,0 +1,260 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.ws.core.server; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.InputStream; +import java.net.URL; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import javax.servlet.Servlet; + +import org.jboss.logging.Logger; +import org.jboss.ws.WSException; +import org.jboss.ws.core.utils.DOMUtils; +import org.jboss.ws.core.utils.DOMWriter; +import org.jboss.ws.core.utils.IOUtils; +import org.jboss.ws.core.utils.JavaUtils; +import org.w3c.dom.Element; + +/** + * The publisher for web service endpoints + * + * @author Thomas.Diesler(a)jboss.org + * @since 12-May-2006 + */ +public abstract class AbstractServiceEndpointPublisher +{ + // default bean name + public static final String BEAN_NAME = "ServiceEndpointPublisher"; + + // The servlet init param in web.xml that is the service endpoint class + public static final String INIT_PARAM_SERVICE_ENDPOINT_IMPL = "ServiceEndpointImpl"; + + // logging support + private static Logger log = Logger.getLogger(AbstractServiceEndpointPublisher.class); + + // The configured service endpoint servlet + protected String servletName; + + public String getServiceEndpointServlet() + { + return servletName; + } + + public void setServiceEndpointServlet(String servletName) + { + this.servletName = servletName; + } + + public abstract String publishServiceEndpoint(UnifiedDeploymentInfo udi) throws Exception; + + public abstract String destroyServiceEndpoint(UnifiedDeploymentInfo udi) throws Exception; + + public URL rewriteWebXml(UnifiedDeploymentInfo udi) + { + URL warURL = udi.expandedWebApp; + return rewriteWebXml(warURL); + } + + public URL rewriteWebXml(URL warURL) + { + File warFile = new File(warURL.getFile()); + if (warFile.isDirectory() == false) + throw new WSException("Expected a war directory: " + warURL); + + File webXML = new File(warURL.getFile() + "/WEB-INF/web.xml"); + if (webXML.isFile() == false) + throw new WSException("Cannot find web.xml: " + webXML); + + try + { + // After redeployment there might be a stale copy of the original web.xml.org, we delete it + File orgWebXML = new File(webXML.getCanonicalPath() + ".org"); + orgWebXML.delete(); + + // Rename the web.xml + if (webXML.renameTo(orgWebXML) == false) + throw new WSException("Cannot rename web.xml: " + orgWebXML); + + FileInputStream stream = new FileInputStream(orgWebXML); + return rewriteWebXml(stream, webXML, null); + } + catch (RuntimeException rte) + { + throw rte; + } + catch (Exception e) + { + throw new WSException(e); + } + } + + public URL rewriteWebXml(InputStream source, File dest, ClassLoader loader) throws Exception + { + if (dest == null) + { + dest = File.createTempFile("jbossws-alt-web", "xml", IOUtils.createTempDirectory()); + dest.deleteOnExit(); + } + + Element root = DOMUtils.parse(source); + modifyServletConfig(root, loader); + + FileOutputStream fos = new FileOutputStream(dest); + new DOMWriter(fos).setPrettyprint(true).print(root); + fos.flush(); + fos.close(); + + return dest.toURL(); + } + + private void modifyServletConfig(Element root, ClassLoader loader) throws ClassNotFoundException + { + Iterator itServlets = DOMUtils.getChildElements(root, "servlet"); + while (itServlets.hasNext()) + { + Element servletElement = (Element)itServlets.next(); + String linkName = DOMUtils.getTextContent(DOMUtils.getFirstChildElement(servletElement, "servlet-name")); + + // find the servlet-class + Element classElement = DOMUtils.getFirstChildElement(servletElement, "servlet-class"); + + // JSP + if (classElement == null) + continue; + + String servletClassName = DOMUtils.getTextContent(classElement).trim(); + + // Get the servlet class + Class servletClass = null; + if (loader != null) + { + try + { + servletClass = loader.loadClass(servletClassName); + } + catch (ClassNotFoundException ex) + { + log.warn("Cannot load servlet class: " + servletClassName); + } + } + + String targetBeanName = null; + + // Nothing to do if we have an <init-param> + if (isAlreadyModified(servletElement) == false) + { + // Check if it is a real servlet that we can ignore + if (servletClass != null && JavaUtils.isAssignableFrom(Servlet.class, servletClass)) + { + log.info("Ignore servlet: " + servletClassName); + continue; + } + else if (servletClassName.endsWith("Servlet")) + { + log.info("Ignore <servlet-class> that ends with 'Servlet': " + servletClassName); + continue; + } + + // build a list of detached elements that come after <servlet-class> + boolean startDetach = false; + List<Element> detachedElements = new ArrayList<Element>(); + Iterator itDetached = DOMUtils.getChildElements(servletElement); + while (itDetached.hasNext()) + { + Element el = (Element)itDetached.next(); + if (startDetach == true) + { + detachedElements.add(el); + servletElement.removeChild(el); + } + if (el.equals(classElement)) + { + servletElement.removeChild(el); + startDetach = true; + } + } + + // replace the class name + classElement = (Element)DOMUtils.createElement("servlet-class"); + classElement.appendChild(DOMUtils.createTextNode(servletName)); + classElement = (Element)servletElement.getOwnerDocument().importNode(classElement, true); + servletElement.appendChild(classElement); + + // add additional init params + if (servletClassName.equals(servletName) == false) + { + Element paramElement = DOMUtils.createElement("init-param"); + paramElement.appendChild(DOMUtils.createElement("param-name")).appendChild(DOMUtils.createTextNode(INIT_PARAM_SERVICE_ENDPOINT_IMPL)); + paramElement.appendChild(DOMUtils.createElement("param-value")).appendChild(DOMUtils.createTextNode(servletClassName)); + paramElement = (Element)servletElement.getOwnerDocument().importNode(paramElement, true); + servletElement.appendChild(paramElement); + targetBeanName = servletClassName; + } + + // reattach the elements + itDetached = detachedElements.iterator(); + while (itDetached.hasNext()) + { + Element el = (Element)itDetached.next(); + servletElement.appendChild(el); + } + } + else + { + Iterator itParams = DOMUtils.getChildElements(servletElement, "init-param"); + while (itParams.hasNext()) + { + Element elParam = (Element)itParams.next(); + Element elParamName = DOMUtils.getFirstChildElement(elParam, "param-name"); + Element elParamValue = DOMUtils.getFirstChildElement(elParam, "param-value"); + if (INIT_PARAM_SERVICE_ENDPOINT_IMPL.equals(DOMUtils.getTextContent(elParamName))) + { + targetBeanName = DOMUtils.getTextContent(elParamValue); + } + } + } + + if (targetBeanName == null) + throw new IllegalStateException("Cannot obtain service endpoint bean for: " + linkName); + } + } + + // Return true if the web.xml is already modified + private boolean isAlreadyModified(Element servletElement) + { + Iterator itParams = DOMUtils.getChildElements(servletElement, "init-param"); + while (itParams.hasNext()) + { + Element elParam = (Element)itParams.next(); + Element elParamName = DOMUtils.getFirstChildElement(elParam, "param-name"); + if (INIT_PARAM_SERVICE_ENDPOINT_IMPL.equals(DOMUtils.getTextContent(elParamName))) + return true; + } + return false; + } +} \ No newline at end of file Deleted: branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java =================================================================== --- branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java 2006-12-21 14:33:35 UTC (rev 1696) +++ branches/tdiesler/trunk/jbossws/src/main/java/org/jboss/ws/core/server/ServiceEndpointPublisher.java 2006-12-21 14:40:46 UTC (rev 1697) @@ -1,260 +0,0 @@ -/* - * JBoss, Home of Professional Open Source - * Copyright 2005, JBoss Inc., and individual contributors as indicated - * by the @authors tag. See the copyright.txt in the distribution for a - * full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.ws.core.server; - -import java.io.File; -import java.io.FileInputStream; -import java.io.FileOutputStream; -import java.io.InputStream; -import java.net.URL; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import javax.servlet.Servlet; - -import org.jboss.logging.Logger; -import org.jboss.ws.WSException; -import org.jboss.ws.core.utils.DOMUtils; -import org.jboss.ws.core.utils.DOMWriter; -import org.jboss.ws.core.utils.IOUtils; -import org.jboss.ws.core.utils.JavaUtils; -import org.w3c.dom.Element; - -/** - * The publisher for web service endpoints - * - * @author Thomas.Diesler(a)jboss.org - * @since 12-May-2006 - */ -public abstract class ServiceEndpointPublisher -{ - // default bean name - public static final String BEAN_NAME = "ServiceEndpointPublisher"; - - // The servlet init param in web.xml that is the service endpoint class - public static final String INIT_PARAM_SERVICE_ENDPOINT_IMPL = "ServiceEndpointImpl"; - - // logging support - private static Logger log = Logger.getLogger(ServiceEndpointPublisher.class); - - // The configured service endpoint servlet - protected String servletName; - - public String getServiceEndpointServlet() - { - return servletName; - } - - public void setServiceEndpointServlet(String servletName) - { - this.servletName = servletName; - } - - public abstract String publishServiceEndpoint(UnifiedDeploymentInfo udi) throws Exception; - - public abstract String destroyServiceEndpoint(UnifiedDeploymentInfo udi) throws Exception; - - public URL rewriteWebXml(UnifiedDeploymentInfo udi) - { - URL warURL = udi.expandedWebApp; - return rewriteWebXml(warURL); - } - - public URL rewriteWebXml(URL warURL) - { - File warFile = new File(warURL.getFile()); - if (warFile.isDirectory() == false) - throw new WSException("Expected a war directory: " + warURL); - - File webXML = new File(warURL.getFile() + "/WEB-INF/web.xml"); - if (webXML.isFile() == false) - throw new WSException("Cannot find web.xml: " + webXML); - - try - { - // After redeployment there might be a stale copy of the original web.xml.org, we delete it - File orgWebXML = new File(webXML.getCanonicalPath() + ".org"); - orgWebXML.delete(); - - // Rename the web.xml - if (webXML.renameTo(orgWebXML) == false) - throw new WSException("Cannot rename web.xml: " + orgWebXML); - - FileInputStream stream = new FileInputStream(orgWebXML); - return rewriteWebXml(stream, webXML, null); - } - catch (RuntimeException rte) - { - throw rte; - } - catch (Exception e) - { - throw new WSException(e); - } - } - - public URL rewriteWebXml(InputStream source, File dest, ClassLoader loader) throws Exception - { - if (dest == null) - { - dest = File.createTempFile("jbossws-alt-web", "xml", IOUtils.createTempDirectory()); - dest.deleteOnExit(); - } - - Element root = DOMUtils.parse(source); - modifyServletConfig(root, loader); - - FileOutputStream fos = new FileOutputStream(dest); - new DOMWriter(fos).setPrettyprint(true).print(root); - fos.flush(); - fos.close(); - - return dest.toURL(); - } - - private void modifyServletConfig(Element root, ClassLoader loader) throws ClassNotFoundException - { - Iterator itServlets = DOMUtils.getChildElements(root, "servlet"); - while (itServlets.hasNext()) - { - Element servletElement = (Element)itServlets.next(); - String linkName = DOMUtils.getTextContent(DOMUtils.getFirstChildElement(servletElement, "servlet-name")); - - // find the servlet-class - Element classElement = DOMUtils.getFirstChildElement(servletElement, "servlet-class"); - - // JSP - if (classElement == null) - continue; - - String servletClassName = DOMUtils.getTextContent(classElement).trim(); - - // Get the servlet class - Class servletClass = null; - if (loader != null) - { - try - { - servletClass = loader.loadClass(servletClassName); - } - catch (ClassNotFoundException ex) - { - log.warn("Cannot load servlet class: " + servletClassName); - } - } - - String targetBeanName = null; - - // Nothing to do if we have an <init-param> - if (isAlreadyModified(servletElement) == false) - { - // Check if it is a real servlet that we can ignore - if (servletClass != null && JavaUtils.isAssignableFrom(Servlet.class, servletClass)) - { - log.info("Ignore servlet: " + servletClassName); - continue; - } - else if (servletClassName.endsWith("Servlet")) - { - log.info("Ignore <servlet-class> that ends with 'Servlet': " + servletClassName); - continue; - } - - // build a list of detached elements that come after <servlet-class> - boolean startDetach = false; - List<Element> detachedElements = new ArrayList<Element>(); - Iterator itDetached = DOMUtils.getChildElements(servletElement); - while (itDetached.hasNext()) - { - Element el = (Element)itDetached.next(); - if (startDetach == true) - { - detachedElements.add(el); - servletElement.removeChild(el); - } - if (el.equals(classElement)) - { - servletElement.removeChild(el); - startDetach = true; - } - } - - // replace the class name - classElement = (Element)DOMUtils.createElement("servlet-class"); - classElement.appendChild(DOMUtils.createTextNode(servletName)); - classElement = (Element)servletElement.getOwnerDocument().importNode(classElement, true); - servletElement.appendChild(classElement); - - // add additional init params - if (servletClassName.equals(servletName) == false) - { - Element paramElement = DOMUtils.createElement("init-param"); - paramElement.appendChild(DOMUtils.createElement("param-name")).appendChild(DOMUtils.createTextNode(INIT_PARAM_SERVICE_ENDPOINT_IMPL)); - paramElement.appendChild(DOMUtils.createElement("param-value")).appendChild(DOMUtils.createTextNode(servletClassName)); - paramElement = (Element)servletElement.getOwnerDocument().importNode(paramElement, true); - servletElement.appendChild(paramElement); - targetBeanName = servletClassName; - } - - // reattach the elements - itDetached = detachedElements.iterator(); - while (itDetached.hasNext()) - { - Element el = (Element)itDetached.next(); - servletElement.appendChild(el); - } - } - else - { - Iterator itParams = DOMUtils.getChildElements(servletElement, "init-param"); - while (itParams.hasNext()) - { - Element elParam = (Element)itParams.next(); - Element elParamName = DOMUtils.getFirstChildElement(elParam, "param-name"); - Element elParamValue = DOMUtils.getFirstChildElement(elParam, "param-value"); - if (INIT_PARAM_SERVICE_ENDPOINT_IMPL.equals(DOMUtils.getTextContent(elParamName))) - { - targetBeanName = DOMUtils.getTextContent(elParamValue); - } - } - } - - if (targetBeanName == null) - throw new IllegalStateException("Cannot obtain service endpoint bean for: " + linkName); - } - } - - // Return true if the web.xml is already modified - private boolean isAlreadyModified(Element servletElement) - { - Iterator itParams = DOMUtils.getChildElements(servletElement, "init-param"); - while (itParams.hasNext()) - { - Element elParam = (Element)itParams.next(); - Element elParamName = DOMUtils.getFirstChildElement(elParam, "param-name"); - if (INIT_PARAM_SERVICE_ENDPOINT_IMPL.equals(DOMUtils.getTextContent(elParamName))) - return true; - } - return false; - } -} \ No newline at end of file