Axiom
  1. Axiom
  2. AXIOM-388

Add methods to OMElement that allow calculating the namespace context of an element

    Details

    • Type: New Feature New Feature
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.2.13
    • Component/s: API
    • Labels:
      None

      Description

      There are a couple of things that the average Java developer is unable to code correctly. One of these things is calculating the namespace context of an element in an XML document.

      Examples:

      (1) The following change in Axis2 attempts to resolve an issue where the databinding fails to resolve a QName value if the prefix is declared on the SOAP envelope:

      http://svn.apache.org/viewvc?view=revision&revision=398161

      Strictly speaking this change is incorrect because it only takes into account namespaces declared on the soap:Envelope, but not on the soap:Body.

      (2) The following change in Synapse adds code to compile an XPath expression retrieved from an XML configuration document:

      http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/mediators/Value.java?view=diff&r1=1080144&r2=1080145&pathrev=1080145

      To build the namespace context for the XPath expression, the code uses OMElement#getAllDeclaredNamespaces() on the element that has the attribute the XPath expression is extracted from. That is incorrect because namespaces relevant for the interpretation of the XPath expression may also be declared on ancestors of this element.

      (3) RAMPART-40 introduces code that attempts to build a namespace context by scanning the entire document tree for namespace declarations .

      To avoid these issues and to make life easier for developers, Axiom should define high level methods that allow to calculate the namespace context of a given element. There should be actually two methods:

      • One that returns an iterator over all namespace declarations in scope. This method could be used e.g. to initialize the namespace context of an XPath expression.
      • One that returns a NamespaceContext object that can be used with other XML APIs that support this interface.

        Issue Links

          Activity

          Hide
          Hudson added a comment -

          Integrated in ws-axiom-trunk #582 (See https://builds.apache.org/job/ws-axiom-trunk/582/)
          AXIOM-388: Added a getNamespacesInScope method to OMElement.

          veithen :
          Files :

          • /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/xpath/AXIOMXPath.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/NamespaceIterator.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/OMTestSuiteBuilder.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScope.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithDefaultNamespace.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithMaskedDefaultNamespace.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithMaskedNamespace.java
          Show
          Hudson added a comment - Integrated in ws-axiom-trunk #582 (See https://builds.apache.org/job/ws-axiom-trunk/582/ ) AXIOM-388 : Added a getNamespacesInScope method to OMElement. veithen : Files : /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/xpath/AXIOMXPath.java /webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/NamespaceIterator.java /webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/OMTestSuiteBuilder.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScope.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithDefaultNamespace.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithMaskedDefaultNamespace.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespacesInScopeWithMaskedNamespace.java
          Hide
          Hudson added a comment -

          Integrated in Rampart #584 (See https://builds.apache.org/job/Rampart/584/)
          RAMPART-324: Added the test case provided by Amila Jayasekara, but implemented a proper fix based on the feature added by AXIOM-388.

          veithen :
          Files :

          • /axis/axis2/java/rampart/trunk/modules/rampart-integration/pom.xml
          • /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/java/org/apache/rampart/RampartTest.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/resources/rampart/policy/33.xml
          • /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/resources/rampart/services-33.xml
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/EncryptedElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/RequiredElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/SignedElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/ContentEncryptedElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/EncryptedElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/RequiredElementsBuilder.java
          • /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/SignedElementsBuilder.java
          Show
          Hudson added a comment - Integrated in Rampart #584 (See https://builds.apache.org/job/Rampart/584/ ) RAMPART-324 : Added the test case provided by Amila Jayasekara, but implemented a proper fix based on the feature added by AXIOM-388 . veithen : Files : /axis/axis2/java/rampart/trunk/modules/rampart-integration/pom.xml /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/java/org/apache/rampart/RampartTest.java /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/resources/rampart/policy/33.xml /axis/axis2/java/rampart/trunk/modules/rampart-integration/src/test/resources/rampart/services-33.xml /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/EncryptedElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/RequiredElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy11/builders/SignedElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/ContentEncryptedElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/EncryptedElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/RequiredElementsBuilder.java /axis/axis2/java/rampart/trunk/modules/rampart-policy/src/main/java/org/apache/ws/secpolicy12/builders/SignedElementsBuilder.java
          Hide
          Hudson added a comment -

          Integrated in ws-axiom-trunk #641 (See https://builds.apache.org/job/ws-axiom-trunk/641/)

          • AXIOM-388: Added an OMElement#getNamespaceContext method.
          • Fixed an issue in OMElement#findNamespace related to namespace prefixes that are redeclared.

          veithen :
          Files :

          • /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
          • /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-common-impl/src/main/java/org/apache/axiom/om/impl/common/LiveNamespaceContext.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMElementImplUtil.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/OMTestSuiteBuilder.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestFindNamespaceByNamespaceURIMasked.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespaceContext.java
          • /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/resources/org/apache/axiom/ts/om/element/namespacecontext.xml
          Show
          Hudson added a comment - Integrated in ws-axiom-trunk #641 (See https://builds.apache.org/job/ws-axiom-trunk/641/ ) AXIOM-388 : Added an OMElement#getNamespaceContext method. Fixed an issue in OMElement#findNamespace related to namespace prefixes that are redeclared. veithen : Files : /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java /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-common-impl/src/main/java/org/apache/axiom/om/impl/common/LiveNamespaceContext.java /webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMElementImplUtil.java /webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/OMTestSuiteBuilder.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestFindNamespaceByNamespaceURIMasked.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/element/TestGetNamespaceContext.java /webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/resources/org/apache/axiom/ts/om/element/namespacecontext.xml
          Hide
          Hudson added a comment -

          Integrated in ws-axiom-trunk #644 (See https://builds.apache.org/job/ws-axiom-trunk/644/)
          AXIOM-388: Minor Javadoc enhancement.

          veithen :
          Files :

          • /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
          Show
          Hudson added a comment - Integrated in ws-axiom-trunk #644 (See https://builds.apache.org/job/ws-axiom-trunk/644/ ) AXIOM-388 : Minor Javadoc enhancement. veithen : Files : /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java

            People

            • Assignee:
              Andreas Veithen
              Reporter:
              Andreas Veithen
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development