SWS-281

Author: poutsma

pom.xml

@@ -662,6 +662,7 @@
                         <link>http://jakarta.apache.org/commons/httpclient/apidocs/</link>
                         <link>http://ws.apache.org/wss4j/apidocs/</link>
                         <link>http://java.sun.com/javase/6/docs/jre/api/net/httpserver/spec/</link>
+                        <link>http://ws.apache.org/commons/XmlSchema/apidocs/</link>
                     </links>
                 </configuration>
             </plugin>

sandbox/src/test/java/org/springframework/ws/wsdl/wsdl11/CommonXsdTest.java

@@ -29,15 +29,15 @@
 public interface XsdSchema {
 
     /**
-     * Returns the target namespace of theis schema.
+     * Returns the target namespace of this schema.
      *
      * @return the target namespace
      */
     String getTargetNamespace();
 
     /**
-     * Returns the qualified names of all top-level elements declared in the schema. This excludes elements declared as child of
-     * another <code>element</code>, <code>simplyType</code>, or <code>complexType</code>.
+     * Returns the qualified names of all top-level elements declared in the schema. This excludes elements declared as
+     * child of another <code>element</code>, <code>simplyType</code>, or <code>complexType</code>.
      *
      * @return the top-level element names
      */

xml/src/main/java/org/springframework/xml/xsd/XsdSchema.java

@@ -18,7 +18,6 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -27,9 +26,6 @@
 import javax.xml.transform.stream.StreamSource;
 
 import org.apache.ws.commons.schema.XmlSchema;
-import org.apache.ws.commons.schema.XmlSchemaCollection;
-import org.apache.ws.commons.schema.XmlSchemaObjectCollection;
-import org.xml.sax.SAXException;
 
 import org.springframework.util.Assert;
 import org.springframework.xml.xsd.XsdSchema;
@@ -43,7 +39,7 @@
  */
 public class CommonsXsdSchema implements XsdSchema {
 
-    private XmlSchema schema;
+    private final XmlSchema schema;
 
     /**
      * Create a new instance of the  {@link CommonsXsdSchema} class with the specified {@link XmlSchema} reference.
@@ -70,17 +66,6 @@ public QName[] getElementNames() {
         return (QName[]) result.toArray(new QName[result.size()]);
     }
 
-    public void merge(XsdSchema o) {
-        Assert.isInstanceOf(CommonsXsdSchema.class, o);
-        XmlSchema otherSchema = ((CommonsXsdSchema) o).schema;
-        Assert.isTrue(this.schema.getTargetNamespace().equals(otherSchema.getTargetNamespace()),
-                "Schema does not have same namespace");
-        XmlSchemaObjectCollection otherItems = otherSchema.getItems();
-        for (int i = 0; i < otherItems.getCount(); i++) {
-            schema.getItems().add(otherItems.getItem(i));
-        }
-    }
-
     public Source getSource() {
         ByteArrayOutputStream bos = new ByteArrayOutputStream();
         schema.write(bos);
@@ -93,51 +78,6 @@ public XmlSchema getSchema() {
         return schema;
     }
 
-    private void loadSchema() throws SAXException, IOException {
-        XmlSchemaCollection schemaCollection = new XmlSchemaCollection();
-//        this.schema = schemaCollection.read(SaxUtils.createInputSource(xsdResource), null);
-    }
-
-    /*
-    public XsdSchema[] inline() {
-        XmlSchema clone = cloneSchema(schema);
-        inlineIncludes(clone, new ArrayList());
-        return new XsdSchema[]{new CommonsXsdSchema(clone)};
-    }
-
-    private static XmlSchema cloneSchema(XmlSchema schema)  {
-        XmlSchemaCollection schemaCollection = new XmlSchemaCollection();
-        XmlSchema clone = new XmlSchema(schemaCollection);
-        XmlSchemaObjectCollection originalItems = schema.getItems();
-        XmlSchemaObjectCollection cloneItems = clone.getItems();
-        for (int i = 0; i < originalItems.getCount(); i++) {
-            cloneItems.add(originalItems.getItem(i));
-        }
-        return clone;
-    }
-
-    private static void inlineIncludes(XmlSchema schema, List processedSchemas) {
-        processedSchemas.add(schema);
-        XmlSchemaObjectCollection includes = schema.getIncludes();
-        for (int i = 0; i < includes.getCount(); i++) {
-            if (includes.getItem(i) instanceof XmlSchemaInclude) {
-                XmlSchemaInclude include = (XmlSchemaInclude) includes.getItem(i);
-                XmlSchema includedSchema = include.getSchema();
-                XmlSchemaObjectCollection items = schema.getItems();
-                if (!processedSchemas.contains(includedSchema)) {
-                    inlineIncludes(includedSchema, processedSchemas);
-                    XmlSchemaObjectCollection includesItems = includedSchema.getItems();
-                    for (int j = 0; j < includesItems.getCount(); j++) {
-                        XmlSchemaObject includedItem = includesItems.getItem(j);
-                        items.add(includedItem);
-                    }
-                }
-                // remove the <include/>
-                items.remove(include);
-            }
-        }
-    }*/
-
     public String toString() {
         StringBuffer buffer = new StringBuffer("CommonsXsdSchema");
         buffer.append('{');

xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java

@@ -16,14 +16,18 @@
 
 package org.springframework.xml.xsd.commons;
 
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
+import org.apache.ws.commons.schema.ValidationEventHandler;
 import org.apache.ws.commons.schema.XmlSchema;
 import org.apache.ws.commons.schema.XmlSchemaCollection;
-import org.apache.ws.commons.schema.constants.Constants;
+import org.apache.ws.commons.schema.XmlSchemaExternal;
+import org.apache.ws.commons.schema.XmlSchemaImport;
+import org.apache.ws.commons.schema.XmlSchemaInclude;
+import org.apache.ws.commons.schema.XmlSchemaObject;
+import org.apache.ws.commons.schema.XmlSchemaObjectCollection;
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.core.io.Resource;
@@ -34,22 +38,26 @@
 
 /**
  * Implementation of the {@link XsdSchemaCollection} that uses Apache WS-Commons XML Schema.
+ * <p/>
+ * Setting the {@link #setInline(boolean) inline} flag to <code>true</code> will result in all referenced schemas
+ * (included and imported) being merged into the referred schema. When including the schemas into a WSDL, this greatly
+ * simplifies the deloyment of the schemas.
  *
  * @author Arjen Poutsma
  * @see <a href="http://ws.apache.org/commons/XmlSchema/">Commons XML Schema</a>
  * @since 1.5.0
  */
 public class CommonsXsdSchemaCollection implements XsdSchemaCollection, InitializingBean {
 
-    private static final Log logger = LogFactory.getLog(CommonsXsdSchemaCollection.class);
-
     private final XmlSchemaCollection schemaCollection = new XmlSchemaCollection();
 
     private final List xmlSchemas = new ArrayList();
 
     private Resource[] xsdResources;
 
-    private boolean inlineIncludes = false;
+    private boolean inline = false;
+
+    private ValidationEventHandler validationEventHandler;
 
     /**
      * Constructs a new, empty instance of the <code>CommonsXsdSchemaCollection</code>.
@@ -82,15 +90,26 @@ public void setXsds(Resource[] xsdResources) {
      * <p/>
      * Defaults to <code>false</code>.
      */
-    public void setInlineIncludes(boolean inlineIncludes) {
-        this.inlineIncludes = inlineIncludes;
+    public void setInline(boolean inline) {
+        this.inline = inline;
     }
 
-    public void afterPropertiesSet() throws Exception {
+    /** Sets the WS-Commons validation event handler to use while parsing schemas. */
+    public void setValidationEventHandler(ValidationEventHandler validationEventHandler) {
+        this.validationEventHandler = validationEventHandler;
+    }
+
+    public void afterPropertiesSet() throws IOException {
         Assert.notEmpty(xsdResources, "'xsds' must not be empty");
         for (int i = 0; i < xsdResources.length; i++) {
             Assert.isTrue(xsdResources[i].exists(), xsdResources[i] + " does not exit");
-            xmlSchemas.add(schemaCollection.read(SaxUtils.createInputSource(xsdResources[i]), null));
+            XmlSchema xmlSchema =
+                    schemaCollection.read(SaxUtils.createInputSource(xsdResources[i]), validationEventHandler);
+            xmlSchemas.add(xmlSchema);
+            if (inline) {
+                inlineIncludes(xmlSchema, new ArrayList());
+                findImports(xmlSchema, new ArrayList());
+            }
         }
     }
 
@@ -103,16 +122,55 @@ public XsdSchema[] getXsdSchemas() {
         return result;
     }
 
+    private void inlineIncludes(XmlSchema schema, List processedSchemas) {
+        processedSchemas.add(schema);
+        XmlSchemaObjectCollection includes = schema.getIncludes();
+        for (int i = 0; i < includes.getCount(); i++) {
+            XmlSchemaExternal external = (XmlSchemaExternal) includes.getItem(i);
+            if (external instanceof XmlSchemaInclude) {
+                XmlSchema includedSchema = external.getSchema();
+                XmlSchemaObjectCollection items = schema.getItems();
+                if (!processedSchemas.contains(includedSchema)) {
+                    inlineIncludes(includedSchema, processedSchemas);
+                    findImports(includedSchema, new ArrayList());
+                    XmlSchemaObjectCollection includeItems = includedSchema.getItems();
+                    for (int j = 0; j < includeItems.getCount(); j++) {
+                        XmlSchemaObject includedItem = includeItems.getItem(j);
+                        items.add(includedItem);
+                    }
+                }
+                // remove the <include/>
+                items.remove(external);
+            }
+        }
+    }
+
+    private void findImports(XmlSchema schema, List processedSchemas) {
+        processedSchemas.add(schema);
+        XmlSchemaObjectCollection includes = schema.getIncludes();
+        for (int i = 0; i < includes.getCount(); i++) {
+            XmlSchemaExternal external = (XmlSchemaExternal) includes.getItem(i);
+            if (external instanceof XmlSchemaImport) {
+                XmlSchema importedSchema = external.getSchema();
+                if (!processedSchemas.contains(importedSchema)) {
+                    inlineIncludes(importedSchema, processedSchemas);
+                    findImports(importedSchema, processedSchemas);
+                    xmlSchemas.add(importedSchema);
+                }
+                // remove the schemaLocation
+                external.setSchemaLocation(null);
+            }
+        }
+    }
+
     public String toString() {
         StringBuffer buffer = new StringBuffer("CommonsXsdSchemaCollection");
         buffer.append('{');
-        XmlSchema[] schemas = schemaCollection.getXmlSchemas();
-        for (int i = 0; i < schemas.length; i++) {
-            if (!Constants.URI_2001_SCHEMA_XSD.equals(schemas[i].getTargetNamespace())) {
-                buffer.append(schemas[i].getTargetNamespace());
-                if (i < schemas.length - 1) {
-                    buffer.append(',');
-                }
+        for (int i = 0; i < xmlSchemas.size(); i++) {
+            XmlSchema schema = (XmlSchema) xmlSchemas.get(i);
+            buffer.append(schema.getTargetNamespace());
+            if (i < xmlSchemas.size() - 1) {
+                buffer.append(',');
             }
         }
         buffer.append('}');