Package org.apache.tomcat.util.descriptor.web

Class WebXmlParser

  • public class WebXmlParser
extends java.lang.Object
    Parser for web.xml and web-fragment.xml deployment descriptors.

    • Constructor Summary

      Constructors 
      Constructor Description
      WebXmlParser​(boolean namespaceAware, boolean validation, boolean blockExternal)
      Constructs a new WebXmlParser.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean parseWebXml​(java.net.URL url, WebXml dest, boolean fragment)
      Parse a web descriptor at a location.
      boolean parseWebXml​(org.xml.sax.InputSource source, WebXml dest, boolean fragment)
      Parses a web descriptor from an InputSource.
      void setClassLoader​(java.lang.ClassLoader classLoader)
      Sets the ClassLoader to be used for creating descriptor objects.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WebXmlParser

        public WebXmlParser​(boolean namespaceAware,
                    boolean validation,
                    boolean blockExternal)
        Constructs a new WebXmlParser.
        Parameters:
        namespaceAware - Whether the parser is namespace aware
        validation - Whether validation is enabled
        blockExternal - Whether external entities are blocked

    • Method Detail

      • parseWebXml

        public boolean parseWebXml​(java.net.URL url,
                           WebXml dest,
                           boolean fragment)
                    throws java.io.IOException
        Parse a web descriptor at a location.
        Parameters:
        url - the location; if null no load will be attempted
        dest - the instance to be populated by the parse operation
        fragment - indicate if the descriptor is a web-app or web-fragment
        Returns:
        true if the descriptor was successfully parsed
        Throws:
        java.io.IOException - if there was a problem reading from the URL

      • parseWebXml

        public boolean parseWebXml​(org.xml.sax.InputSource source,
                           WebXml dest,
                           boolean fragment)
        Parses a web descriptor from an InputSource.
        Parameters:
        source - The input source
        dest - The WebXml instance to populate
        fragment - Whether this is a web-fragment
        Returns:
        true if parsing was successful

      • setClassLoader

        public void setClassLoader​(java.lang.ClassLoader classLoader)
        Sets the ClassLoader to be used for creating descriptor objects.
        Parameters:
        classLoader - the ClassLoader to be used for creating descriptor objects