You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-dev@ws.apache.org by ve...@apache.org on 2010/09/30 16:40:02 UTC

svn commit: r1003082 - in /webservices/commons/trunk/modules/axiom/modules/axiom-api/src: main/java/org/apache/axiom/util/namespace/ main/java/org/apache/axiom/util/stax/dialect/ test/java/org/apache/axiom/util/namespace/ test/java/org/apache/axiom/uti...

Author: veithen
Date: Thu Sep 30 14:40:01 2010
New Revision: 1003082

URL: http://svn.apache.org/viewvc?rev=1003082&view=rev
Log:
The Javadoc of NamespaceContext#getNamespaceURI specifies that this method never returns null, but that XMLConstants.NULL_NS_URI ("") is used for unbound prefixes. Strictly enforce this behavior.

Added:
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java   (with props)
Modified:
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/ScopedNamespaceContext.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/BEAStreamReaderWrapper.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/SJSXPNamespaceContextWrapper.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/WoodstoxStreamReaderWrapper.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/namespace/ScopedNamespaceContextTest.java
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/stax/dialect/GetNamespaceContextTestCase.java

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/MapBasedNamespaceContext.java Thu Sep 30 14:40:01 2010
@@ -25,6 +25,8 @@ import java.util.Iterator;
 import java.util.Map;
 import java.util.Set;
 
+import javax.xml.XMLConstants;
+
 /**
  * Namespace context implementation that stores namespace bindings in a {@link Map}.
  */
@@ -36,7 +38,8 @@ public class MapBasedNamespaceContext ex
     }
 
     protected String doGetNamespaceURI(String prefix) {
-        return (String) namespaces.get(prefix);
+        String namespaceURI = (String)namespaces.get(prefix);
+        return namespaceURI == null ? XMLConstants.NULL_NS_URI : namespaceURI;
     }
 
     protected String doGetPrefix(String nsURI) {

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/ScopedNamespaceContext.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/ScopedNamespaceContext.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/ScopedNamespaceContext.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/namespace/ScopedNamespaceContext.java Thu Sep 30 14:40:01 2010
@@ -22,6 +22,7 @@ package org.apache.axiom.util.namespace;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 
+import javax.xml.XMLConstants;
 import javax.xml.namespace.NamespaceContext;
 
 /**
@@ -114,7 +115,9 @@ public class ScopedNamespaceContext exte
                 return uriArray[i];
             }
         }
-        return null;
+        // The Javadoc of NamespaceContext#getNamespaceURI specifies that XMLConstants.NULL_NS_URI
+        // is returned both for unbound prefixes and the null namespace
+        return XMLConstants.NULL_NS_URI;
     }
 
     protected String doGetPrefix(String namespaceURI) {

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/BEAStreamReaderWrapper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/BEAStreamReaderWrapper.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/BEAStreamReaderWrapper.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/BEAStreamReaderWrapper.java Thu Sep 30 14:40:01 2010
@@ -140,7 +140,8 @@ class BEAStreamReaderWrapper extends XML
         // The NamespaceContext returned by the reference doesn't handle the
         // implicit namespace bindings (for the "xml" and "xmlns" prefixes)
         // correctly
-        return new ImplicitNamespaceContextWrapper(super.getNamespaceContext());
+        return new ImplicitNamespaceContextWrapper(
+                new NamespaceURICorrectingNamespaceContextWrapper(super.getNamespaceContext()));
     }
 
     public XMLStreamReader getParent() {

Added: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java?rev=1003082&view=auto
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java (added)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java Thu Sep 30 14:40:01 2010
@@ -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.axiom.util.stax.dialect;
+
+import java.util.Iterator;
+
+import javax.xml.XMLConstants;
+import javax.xml.namespace.NamespaceContext;
+
+/**
+ * Wrapper that fixes the behavior of {@link NamespaceContext#getNamespaceURI(String)}. The Javadoc
+ * of that method clearly specifies that the return value of that method may never be
+ * <code>null</code>. In particular, the expected result for an unbound prefix is
+ * {@link XMLConstants#NULL_NS_URI}. However, many implementations incorrectly return
+ * <code>null</code> in that case.
+ */
+class NamespaceURICorrectingNamespaceContextWrapper implements NamespaceContext {
+    private final NamespaceContext parent;
+    
+    public NamespaceURICorrectingNamespaceContextWrapper(NamespaceContext parent) {
+        this.parent = parent;
+    }
+
+    public String getNamespaceURI(String prefix) {
+        String namespaceURI = parent.getNamespaceURI(prefix);
+        return namespaceURI == null ? XMLConstants.NULL_NS_URI : namespaceURI;
+    }
+
+    public String getPrefix(String namespaceURI) {
+        return parent.getPrefix(namespaceURI);
+    }
+
+    public Iterator getPrefixes(String namespaceURI) {
+        return parent.getPrefixes(namespaceURI);
+    }
+}

Propchange: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/NamespaceURICorrectingNamespaceContextWrapper.java
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/SJSXPNamespaceContextWrapper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/SJSXPNamespaceContextWrapper.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/SJSXPNamespaceContextWrapper.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/SJSXPNamespaceContextWrapper.java Thu Sep 30 14:40:01 2010
@@ -23,6 +23,7 @@ import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 
+import javax.xml.XMLConstants;
 import javax.xml.namespace.NamespaceContext;
 
 class SJSXPNamespaceContextWrapper implements NamespaceContext {
@@ -33,7 +34,8 @@ class SJSXPNamespaceContextWrapper imple
     }
 
     public String getNamespaceURI(String prefix) {
-        return parent.getNamespaceURI(prefix);
+        String namespaceURI = parent.getNamespaceURI(prefix);
+        return namespaceURI == null ? XMLConstants.NULL_NS_URI : namespaceURI;
     }
 
     public String getPrefix(String namespaceURI) {

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/WoodstoxStreamReaderWrapper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/WoodstoxStreamReaderWrapper.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/WoodstoxStreamReaderWrapper.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/dialect/WoodstoxStreamReaderWrapper.java Thu Sep 30 14:40:01 2010
@@ -18,6 +18,7 @@
  */
 package org.apache.axiom.util.stax.dialect;
 
+import javax.xml.namespace.NamespaceContext;
 import javax.xml.stream.XMLStreamReader;
 
 import org.apache.axiom.ext.stax.DelegatingXMLStreamReader;
@@ -106,6 +107,10 @@ class WoodstoxStreamReaderWrapper extend
         return uri == null || uri.length() == 0 ? null : uri;
     }
 
+    public NamespaceContext getNamespaceContext() {
+        return new NamespaceURICorrectingNamespaceContextWrapper(super.getNamespaceContext());
+    }
+
     public XMLStreamReader getParent() {
         return super.getParent();
     }

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/namespace/ScopedNamespaceContextTest.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/namespace/ScopedNamespaceContextTest.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/namespace/ScopedNamespaceContextTest.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/namespace/ScopedNamespaceContextTest.java Thu Sep 30 14:40:01 2010
@@ -25,6 +25,7 @@ import java.util.HashSet;
 import java.util.Iterator;
 import java.util.Set;
 
+import javax.xml.XMLConstants;
 import javax.xml.namespace.NamespaceContext;
 
 import org.apache.axiom.testutils.namespace.NamespaceContextTestUtils;
@@ -80,11 +81,11 @@ public class ScopedNamespaceContextTest 
         nc.endScope();
         assertEquals("urn:ns1", nc.getNamespaceURI("ns1"));
         assertEquals("urn:ns2", nc.getNamespaceURI("ns2"));
-        assertNull(nc.getNamespaceURI("ns3"));
+        assertEquals(XMLConstants.NULL_NS_URI, nc.getNamespaceURI("ns3"));
         nc.endScope();
         assertEquals("urn:ns1", nc.getNamespaceURI("ns1"));
-        assertNull(nc.getNamespaceURI("ns2"));
-        assertNull(nc.getNamespaceURI("ns3"));
+        assertEquals(XMLConstants.NULL_NS_URI, nc.getNamespaceURI("ns2"));
+        assertEquals(XMLConstants.NULL_NS_URI, nc.getNamespaceURI("ns3"));
     }
     
     public void testMaskedPrefix() {

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/stax/dialect/GetNamespaceContextTestCase.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/stax/dialect/GetNamespaceContextTestCase.java?rev=1003082&r1=1003081&r2=1003082&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/stax/dialect/GetNamespaceContextTestCase.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/util/stax/dialect/GetNamespaceContextTestCase.java Thu Sep 30 14:40:01 2010
@@ -84,13 +84,6 @@ public class GetNamespaceContextTestCase
                         String prefix = (String)it.next();
                         String expectedUri = refNc.getNamespaceURI(prefix);
                         String actualUri = nc.getNamespaceURI(prefix);
-                        // TODO: this needs to be clarified
-                        if (expectedUri == null) {
-                            expectedUri = "";
-                        }
-                        if (actualUri == null) {
-                            actualUri = "";
-                        }
                         assertEquals("Namespace URI for prefix '" + prefix + "'", expectedUri, actualUri);
                     }
                     for (Iterator it = namespaceURIs.iterator(); it.hasNext(); ) {