Issue #14209 - Allow custom XmlParser in Descriptor handling

jetty-ee10/jetty-ee10-webapp/src/main/java/org/eclipse/jetty/ee10/webapp/MetaData.java

@@ -24,6 +24,7 @@
 import org.eclipse.jetty.util.resource.Resource;
 import org.eclipse.jetty.util.resource.Resources;
 import org.eclipse.jetty.util.thread.AutoLock;
+import org.eclipse.jetty.xml.XmlParser;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -39,6 +40,7 @@ public class MetaData
 
     private final AutoLock _lock = new AutoLock();
     protected Map<String, OriginInfo> _origins = new HashMap<>();
+    protected XmlParser _xmlParser;
     protected WebDescriptor _webDefaultsRoot;
     protected WebDescriptor _webXmlRoot;
     protected final List<WebDescriptor> _webOverrideRoots = new ArrayList<>();
@@ -185,7 +187,7 @@ public void setDefaultsDescriptor(DefaultsDescriptor descriptor)
         throws Exception
     {
         _webDefaultsRoot = descriptor;
-        _webDefaultsRoot.parse(WebDescriptor.getParser(isValidateXml()));
+        _webDefaultsRoot.parse(getXmlParser());
         if (_webDefaultsRoot.isOrdered())
         {
             Ordering ordering = getOrdering();
@@ -214,7 +216,7 @@ public void setWebDescriptor(WebDescriptor descriptor)
         throws Exception
     {
         _webXmlRoot = descriptor;
-        _webXmlRoot.parse(WebDescriptor.getParser(isValidateXml()));
+        _webXmlRoot.parse(getXmlParser());
         _metaDataComplete = WebDescriptor.isMetaDataComplete(_webXmlRoot);
 
         if (_webXmlRoot.isOrdered())
@@ -245,7 +247,7 @@ public void setWebDescriptor(WebDescriptor descriptor)
     public void addOverrideDescriptor(OverrideDescriptor descriptor)
         throws Exception
     {
-        descriptor.parse(WebDescriptor.getParser(isValidateXml()));
+        descriptor.parse(getXmlParser());
 
         Boolean metaDataComplete = descriptor.getMetaDataComplete();
         if (metaDataComplete != null)
@@ -292,7 +294,7 @@ public void addFragmentDescriptor(Resource jarResource, FragmentDescriptor descr
         //Metadata-complete is not set, or there is no web.xml
         _webFragmentResourceMap.put(jarResource, descriptor);
         _webFragmentRoots.add(descriptor);
-        descriptor.parse(WebDescriptor.getParser(isValidateXml()));
+        descriptor.parse(getXmlParser());
 
         if (descriptor.getName() != null)
         {
@@ -638,9 +640,40 @@ public boolean isValidateXml()
      */
     public void setValidateXml(boolean validateXml)
     {
+        if (_xmlParser != null && _xmlParser.isValidating() != _validateXml)
+            throw new IllegalStateException("XmlParser previously set");
+
         _validateXml = validateXml;
     }
 
+    /**
+     * Set the XmlParser to use for handling metadata, this will
+     * also add an environment specific catalog to the XmlParser.
+     *
+     * <p>This is useful when you want to configure a custom XML Parser
+     * with a variety of custom attributes and configurations.</p>
+     *
+     * @param xmlParser the XML parser to use.
+     */
+    public void setXmlParser(XmlParser xmlParser)
+    {
+        _xmlParser = Objects.requireNonNull(xmlParser);
+
+        WebDescriptor.addDescriptorCatalog(_xmlParser);
+    }
+
+    /**
+     * The XmlParser in use for this metadata.
+     *
+     * @return the in use XML Parser
+     */
+    public XmlParser getXmlParser()
+    {
+        if (_xmlParser == null)
+            setXmlParser(new XmlParser(isValidateXml()));
+        return _xmlParser;
+    }
+
     public Map<String, OriginInfo> getOrigins()
     {
         return Collections.unmodifiableMap(_origins);

jetty-ee10/jetty-ee10-webapp/src/main/java/org/eclipse/jetty/ee10/webapp/WebAppContext.java

@@ -515,7 +515,9 @@ protected void doStart() throws Exception
         {
             _metadata.setAllowDuplicateFragmentNames(isAllowDuplicateFragmentNames());
             Boolean validate = (Boolean)getAttribute(MetaData.VALIDATE_XML);
-            _metadata.setValidateXml((validate != null && validate));
+            // Don't set validate unless it is declared.
+            if (validate != null)
+                _metadata.setValidateXml(validate);
             preConfigure();
             super.doStart();
             postConfigure();
@@ -602,7 +604,7 @@ public Configurations getConfigurations()
      *
      * @return Returns the defaultsDescriptor.
      */
-    @ManagedAttribute(value = "default web.xml deascriptor applied before standard web.xml", readonly = true)
+    @ManagedAttribute(value = "default web.xml descriptor applied before standard web.xml", readonly = true)
     public String getDefaultsDescriptor()
     {
         return _defaultsDescriptor;
@@ -625,7 +627,7 @@ public String getOverrideDescriptor()
      *
      * @return Returns the Override Descriptor list
      */
-    @ManagedAttribute(value = "web.xml deascriptors applied after standard web.xml", readonly = true)
+    @ManagedAttribute(value = "web.xml descriptors applied after standard web.xml", readonly = true)
     public List<String> getOverrideDescriptors()
     {
         return Collections.unmodifiableList(_overrideDescriptors);
@@ -1400,8 +1402,7 @@ protected void stopContext() throws Exception
                 _configurations.get(i).deconfigure(this);
             }
 
-            if (_metadata != null)
-                _metadata.clear();
+            _metadata.clear();
             _metadata = new MetaData();
         }
         finally

jetty-ee10/jetty-ee10-webapp/src/main/java/org/eclipse/jetty/ee10/webapp/WebDescriptor.java

@@ -34,6 +34,10 @@ public class WebDescriptor extends Descriptor
 {
     private static final Logger LOG = LoggerFactory.getLogger(WebDescriptor.class);
 
+    /**
+     * @deprecated no direct replacement, use of {@link MetaData#getXmlParser()} is encouraged.
+     */
+    @Deprecated(since = "12.1.6", forRemoval = true)
     public static XmlParser __nonValidatingStaticParser = newParser(false);
     protected Boolean _metaDataComplete;
     protected int _majorVersion = 4; //default to container version
@@ -61,43 +65,42 @@ public static boolean isMetaDataComplete(WebDescriptor d)
      *
      * @param validating true if the parser should validate syntax, false otherwise
      * @return an XmlParser for web descriptors
+     * @deprecated use {@link MetaData#getXmlParser()} to control parser behavior.
      */
+    @Deprecated(since = "12.1.6", forRemoval = true)
     public static XmlParser getParser(boolean validating)
     {
-        if (!validating)
-            return __nonValidatingStaticParser;
-        else
-            return newParser(true);
+        return newParser(validating);
     }
 
     /**
      * Create a new parser for parsing web descriptors.
      *
      * @param validating if true, the parser will validate syntax
      * @return an XmlParser
+     * @deprecated use {@link MetaData#getXmlParser()} to control parser behavior.
      */
+    @Deprecated(since = "12.1.6", forRemoval = true)
     public static XmlParser newParser(boolean validating)
     {
+        XmlParser xmlParser = new XmlParser(validating);
+        addDescriptorCatalog(xmlParser);
+        return xmlParser;
+    }
+
+    protected static void addDescriptorCatalog(XmlParser xmlParser) throws IllegalStateException
+    {
+        String catalogName = "catalog-%s.xml".formatted(ServletContextHandler.ENVIRONMENT.getName());
+        URL url = WebDescriptor.class.getResource(catalogName);
+        if (url == null)
+            throw new IllegalStateException("Catalog not found: %s/%s".formatted(WebDescriptor.class.getPackageName(), catalogName));
         try
         {
-            return new WebDescriptorParser(validating);
+            xmlParser.addCatalog(URI.create(url.toExternalForm()), Servlet.class);
         }
         catch (IOException e)
         {
-            throw new IllegalStateException("Unable to instantiate WebDescriptorParser", e);
-        }
-    }
-
-    private static class WebDescriptorParser extends XmlParser
-    {
-        public WebDescriptorParser(boolean validating) throws IOException
-        {
-            super(validating);
-            String catalogName = "catalog-%s.xml".formatted(ServletContextHandler.ENVIRONMENT.getName());
-            URL url = WebDescriptor.class.getResource(catalogName);
-            if (url == null)
-                throw new IllegalStateException("Catalog not found: %s/%s".formatted(WebDescriptor.class.getPackageName(), catalogName));
-            addCatalog(URI.create(url.toExternalForm()), Servlet.class);
+            throw new IllegalStateException("Unable to add catalog: " + url, e);
         }
     }
 

jetty-ee10/jetty-ee10-webapp/src/test/java/org/eclipse/jetty/ee10/webapp/WebAppContextTest.java

@@ -78,6 +78,7 @@
 import org.eclipse.jetty.util.resource.FileSystemPool;
 import org.eclipse.jetty.util.resource.Resource;
 import org.eclipse.jetty.util.resource.ResourceFactory;
+import org.eclipse.jetty.xml.XmlParser;
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
@@ -110,6 +111,7 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @Isolated()
@@ -1295,6 +1297,29 @@ public void testAddProtectedClasses() throws Exception
         assertThat("deprecated API", protectedClasses, hasItem("org.deprecated.api."));
     }
 
+    @Test
+    public void testCustomXmlParser(WorkDir workDir) throws Exception
+    {
+        Server server = newServer();
+
+        MyXmlParser xmlParser = new MyXmlParser();
+        WebAppContext context = new WebAppContext();
+        context.getMetaData().setXmlParser(xmlParser);
+        context.setBaseResourceAsPath(workDir.getEmptyPathDir());
+
+        server.setHandler(context);
+        server.start();
+
+        assertTrue(context.isStarted());
+        assertTrue(context.isAvailable());
+        XmlParser startedXmlParser = context.getMetaData().getXmlParser();
+        assertSame(startedXmlParser, xmlParser);
+    }
+
+    public static class MyXmlParser extends XmlParser
+    {
+    }
+
     public static class OkServlet extends HttpServlet
     {
         @Override

jetty-ee10/jetty-ee10-webapp/src/test/java/org/eclipse/jetty/ee10/webapp/WebDescriptorTest.java

@@ -47,7 +47,7 @@ public void testXmlWithXsd(WorkDir workDir) throws Exception
             """, StandardCharsets.UTF_8);
 
         WebDescriptor webDescriptor = new WebDescriptor(ResourceFactory.root().newResource(xml));
-        XmlParser xmlParser = WebDescriptor.newParser(true);
+        XmlParser xmlParser = new XmlParser(true);
         // This should not throw an exception, if it does then you have a bad state.
         // Such as missing required XML resource entities.
         webDescriptor.parse(xmlParser);

jetty-ee11/jetty-ee11-webapp/src/main/java/org/eclipse/jetty/ee11/webapp/MetaData.java

@@ -24,6 +24,7 @@
 import org.eclipse.jetty.util.resource.Resource;
 import org.eclipse.jetty.util.resource.Resources;
 import org.eclipse.jetty.util.thread.AutoLock;
+import org.eclipse.jetty.xml.XmlParser;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -39,6 +40,7 @@ public class MetaData
 
     private final AutoLock _lock = new AutoLock();
     protected Map<String, OriginInfo> _origins = new HashMap<>();
+    protected XmlParser _xmlParser;
     protected WebDescriptor _webDefaultsRoot;
     protected WebDescriptor _webXmlRoot;
     protected final List<WebDescriptor> _webOverrideRoots = new ArrayList<>();
@@ -185,7 +187,7 @@ public void setDefaultsDescriptor(DefaultsDescriptor descriptor)
         throws Exception
     {
         _webDefaultsRoot = descriptor;
-        _webDefaultsRoot.parse(WebDescriptor.getParser(isValidateXml()));
+        _webDefaultsRoot.parse(getXmlParser());
         if (_webDefaultsRoot.isOrdered())
         {
             Ordering ordering = getOrdering();
@@ -214,7 +216,7 @@ public void setWebDescriptor(WebDescriptor descriptor)
         throws Exception
     {
         _webXmlRoot = descriptor;
-        _webXmlRoot.parse(WebDescriptor.getParser(isValidateXml()));
+        _webXmlRoot.parse(getXmlParser());
         _metaDataComplete = WebDescriptor.isMetaDataComplete(_webXmlRoot);
 
         if (_webXmlRoot.isOrdered())
@@ -245,7 +247,7 @@ public void setWebDescriptor(WebDescriptor descriptor)
     public void addOverrideDescriptor(OverrideDescriptor descriptor)
         throws Exception
     {
-        descriptor.parse(WebDescriptor.getParser(isValidateXml()));
+        descriptor.parse(getXmlParser());
 
         Boolean metaDataComplete = descriptor.getMetaDataComplete();
         if (metaDataComplete != null)
@@ -292,7 +294,7 @@ public void addFragmentDescriptor(Resource jarResource, FragmentDescriptor descr
         //Metadata-complete is not set, or there is no web.xml
         _webFragmentResourceMap.put(jarResource, descriptor);
         _webFragmentRoots.add(descriptor);
-        descriptor.parse(WebDescriptor.getParser(isValidateXml()));
+        descriptor.parse(getXmlParser());
 
         if (descriptor.getName() != null)
         {
@@ -638,9 +640,40 @@ public boolean isValidateXml()
      */
     public void setValidateXml(boolean validateXml)
     {
+        if (_xmlParser != null && _xmlParser.isValidating() != _validateXml)
+            throw new IllegalStateException("XmlParser previously set");
+
         _validateXml = validateXml;
     }
 
+    /**
+     * Set the XmlParser to use for handling metadata, this will
+     * also add an environment specific catalog to the XmlParser.
+     *
+     * <p>This is useful when you want to configure a custom XML Parser
+     * with a variety of custom attributes and configurations.</p>
+     *
+     * @param xmlParser the XML parser to use.
+     */
+    public void setXmlParser(XmlParser xmlParser)
+    {
+        _xmlParser = Objects.requireNonNull(xmlParser);
+
+        WebDescriptor.addDescriptorCatalog(_xmlParser);
+    }
+
+    /**
+     * The XmlParser in use for this metadata.
+     *
+     * @return the in use XML Parser
+     */
+    public XmlParser getXmlParser()
+    {
+        if (_xmlParser == null)
+            setXmlParser(new XmlParser(isValidateXml()));
+        return _xmlParser;
+    }
+
     public Map<String, OriginInfo> getOrigins()
     {
         return Collections.unmodifiableMap(_origins);

jetty-ee11/jetty-ee11-webapp/src/main/java/org/eclipse/jetty/ee11/webapp/WebAppContext.java

@@ -13,7 +13,6 @@
 
 package org.eclipse.jetty.ee11.webapp;
 
-import java.io.File;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URI;
@@ -494,7 +493,9 @@ protected void doStart() throws Exception
         {
             _metadata.setAllowDuplicateFragmentNames(isAllowDuplicateFragmentNames());
             Boolean validate = (Boolean)getAttribute(MetaData.VALIDATE_XML);
-            _metadata.setValidateXml((validate != null && validate));
+            // Don't set validate unless it is declared.
+            if (validate != null)
+                _metadata.setValidateXml(validate);
             preConfigure();
             super.doStart();
             postConfigure();
@@ -581,7 +582,7 @@ public Configurations getConfigurations()
      *
      * @return Returns the defaultsDescriptor.
      */
-    @ManagedAttribute(value = "default web.xml deascriptor applied before standard web.xml", readonly = true)
+    @ManagedAttribute(value = "default web.xml descriptor applied before standard web.xml", readonly = true)
     public String getDefaultsDescriptor()
     {
         return _defaultsDescriptor;
@@ -604,7 +605,7 @@ public String getOverrideDescriptor()
      *
      * @return Returns the Override Descriptor list
      */
-    @ManagedAttribute(value = "web.xml deascriptors applied after standard web.xml", readonly = true)
+    @ManagedAttribute(value = "web.xml descriptors applied after standard web.xml", readonly = true)
     public List<String> getOverrideDescriptors()
     {
         return Collections.unmodifiableList(_overrideDescriptors);
@@ -1286,8 +1287,7 @@ protected void stopContext() throws Exception
                 _configurations.get(i).deconfigure(this);
             }
 
-            if (_metadata != null)
-                _metadata.clear();
+            _metadata.clear();
             _metadata = new MetaData();
         }
         finally