Fixes piranhacloud#4184 - Refactor web.xml processing to hide WebXmlX…

…XX as internal API (piranhacloud#4443)
mnriem · Dec 30, 2024 · 486ed85 · 486ed85
1 parent b191881
commit 486ed85
Show file tree

Hide file tree

Showing 43 changed files with 97 additions and 166 deletions.
diff --git a/extension/webxml/src/main/java/cloud/piranha/extension/webxml/WebXmlInitializer.java b/extension/webxml/src/main/java/cloud/piranha/extension/webxml/WebXmlInitializer.java
@@ -27,10 +27,15 @@
  */
 package cloud.piranha.extension.webxml;
 
-import cloud.piranha.extension.webxml.internal.InternalWebXmlParser;
-import cloud.piranha.extension.webxml.internal.InternalWebXmlProcessor;
-import cloud.piranha.extension.webxml.internal.InternalWebXmlManager;
+import cloud.piranha.extension.webxml.internal.WebXmlParser;
+import cloud.piranha.extension.webxml.internal.WebXmlProcessor;
+import cloud.piranha.extension.webxml.internal.WebXmlManager;
 import cloud.piranha.core.api.WebApplication;
+import cloud.piranha.extension.webxml.internal.WebXmlManager;
+import cloud.piranha.extension.webxml.internal.WebXmlParser;
+import cloud.piranha.extension.webxml.internal.WebXmlProcessor;
+import cloud.piranha.extension.webxml.internal.WebXml;
+import cloud.piranha.extension.webxml.internal.WebXmlServletMapping;
 import jakarta.servlet.ServletContainerInitializer;
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletException;
@@ -76,10 +81,10 @@ public void onStartup(Set<Class<?>> classes, ServletContext servletContext) thro
 
         try {
             WebApplication webApplication = (WebApplication) servletContext;
-            InternalWebXmlManager manager = new InternalWebXmlManager();
+            WebXmlManager manager = new WebXmlManager();
             webApplication.setAttribute("cloud.piranha.extension.webxml.WebXmlManager", manager);
 
-            InternalWebXmlParser parser = new InternalWebXmlParser();
+            WebXmlParser parser = new WebXmlParser();
             InputStream inputStream = servletContext.getResourceAsStream("WEB-INF/web.xml");
             if (inputStream != null) {
                 WebXml webXml = parser.parse(servletContext.getResourceAsStream("WEB-INF/web.xml"));
@@ -106,7 +111,7 @@ public void onStartup(Set<Class<?>> classes, ServletContext servletContext) thro
 
             if (manager.getWebXml() != null) {
                 WebXml webXml = manager.getWebXml();
-                InternalWebXmlProcessor processor = new InternalWebXmlProcessor();
+                WebXmlProcessor processor = new WebXmlProcessor();
 
                 processor.process(webXml, webApplication);
 
@@ -134,7 +139,7 @@ public void onStartup(Set<Class<?>> classes, ServletContext servletContext) thro
      * @param webApp the web application.
      * @param manager the web.xml manager.
      */
-    private void removeExistingServletMappings(WebApplication webApp, InternalWebXmlManager manager) {
+    private void removeExistingServletMappings(WebApplication webApp, WebXmlManager manager) {
         for(WebXmlServletMapping mapping : manager.getWebXml().getServletMappings()) {
             for(WebXml fragment : manager.getOrderedFragments()) {
                 ArrayList<WebXmlServletMapping> candidateList = new ArrayList<>(fragment.getServletMappings());

diff --git a/extension/webxml/src/main/java/cloud/piranha/extension/webxml/WebXmlManager.java b/extension/webxml/src/main/java/cloud/piranha/extension/webxml/WebXmlManager.java
diff --git a/...loud/piranha/extension/webxml/WebXml.java → ...nha/extension/webxml/internal/WebXml.java b/...loud/piranha/extension/webxml/WebXml.java → ...nha/extension/webxml/internal/WebXml.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.io.Serializable;
 import java.util.ArrayList;

diff --git a/.../extension/webxml/WebXmlContextParam.java → ...n/webxml/internal/WebXmlContextParam.java b/.../extension/webxml/WebXmlContextParam.java → ...n/webxml/internal/WebXmlContextParam.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A context-param inside of web.xml/web-fragment.xml.

diff --git a/...ha/extension/webxml/WebXmlDataSource.java → ...ion/webxml/internal/WebXmlDataSource.java b/...ha/extension/webxml/WebXmlDataSource.java → ...ion/webxml/internal/WebXmlDataSource.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.HashMap;
 import java.util.Map;

diff --git a/...nha/extension/webxml/WebXmlErrorPage.java → ...sion/webxml/internal/WebXmlErrorPage.java b/...nha/extension/webxml/WebXmlErrorPage.java → ...sion/webxml/internal/WebXmlErrorPage.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * An error-page inside of web.xml/web-fragment.xml.

diff --git a/...iranha/extension/webxml/WebXmlFilter.java → ...tension/webxml/internal/WebXmlFilter.java b/...iranha/extension/webxml/WebXmlFilter.java → ...tension/webxml/internal/WebXmlFilter.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...tension/webxml/WebXmlFilterInitParam.java → ...ebxml/internal/WebXmlFilterInitParam.java b/...tension/webxml/WebXmlFilterInitParam.java → ...ebxml/internal/WebXmlFilterInitParam.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A filter init-param inside of web.xml/web-fragment.xml.

diff --git a/...extension/webxml/WebXmlFilterMapping.java → .../webxml/internal/WebXmlFilterMapping.java b/...extension/webxml/WebXmlFilterMapping.java → .../webxml/internal/WebXmlFilterMapping.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...nha/extension/webxml/WebXmlJspConfig.java → ...sion/webxml/internal/WebXmlJspConfig.java b/...nha/extension/webxml/WebXmlJspConfig.java → ...sion/webxml/internal/WebXmlJspConfig.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...tension/webxml/WebXmlJspConfigTaglib.java → ...ebxml/internal/WebXmlJspConfigTaglib.java b/...tension/webxml/WebXmlJspConfigTaglib.java → ...ebxml/internal/WebXmlJspConfigTaglib.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A taglib inside jsp-config of web.xml/web-fragment.xml.

diff --git a/...anha/extension/webxml/WebXmlListener.java → ...nsion/webxml/internal/WebXmlListener.java b/...anha/extension/webxml/WebXmlListener.java → ...nsion/webxml/internal/WebXmlListener.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A listener inside of web.xml/web-fragment.xml.

diff --git a/...a/extension/webxml/WebXmlLoginConfig.java → ...on/webxml/internal/WebXmlLoginConfig.java b/...a/extension/webxml/WebXmlLoginConfig.java → ...on/webxml/internal/WebXmlLoginConfig.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A login-config inside of web.xml/web-fragment.xml.

diff --git a/...ebxml/internal/InternalWebXmlManager.java → ...ension/webxml/internal/WebXmlManager.java b/...ebxml/internal/InternalWebXmlManager.java → ...ension/webxml/internal/WebXmlManager.java
@@ -27,9 +27,7 @@
  */
 package cloud.piranha.extension.webxml.internal;
 
-import cloud.piranha.extension.webxml.WebXml;
-import static cloud.piranha.extension.webxml.WebXml.OTHERS_TAG;
-import cloud.piranha.extension.webxml.WebXmlManager;
+import static cloud.piranha.extension.webxml.internal.WebXml.OTHERS_TAG;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
@@ -47,7 +45,7 @@
  *
  * @author Manfred Riem (mriem@manorrock.com)
  */
-public class InternalWebXmlManager implements WebXmlManager {
+public class WebXmlManager {
 
     /**
      * Stores the initial web.xml
@@ -96,7 +94,11 @@ public void setWebFragments(List<WebXml> webFragments) {
         this.webFragments = webFragments;
     }
 
-    @Override
+    /**
+     * Get the web.xml.
+     * 
+     * @return the web.xml.
+     */
     public WebXml getWebXml() {
         return webXml;
     }

diff --git a/...a/extension/webxml/WebXmlMimeMapping.java → ...on/webxml/internal/WebXmlMimeMapping.java b/...a/extension/webxml/WebXmlMimeMapping.java → ...on/webxml/internal/WebXmlMimeMapping.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A mime-mapping inside of web.xml/web-fragment.xml.

diff --git a/...webxml/internal/InternalWebXmlParser.java → ...tension/webxml/internal/WebXmlParser.java b/...webxml/internal/InternalWebXmlParser.java → ...tension/webxml/internal/WebXmlParser.java
@@ -27,7 +27,7 @@
  */
 package cloud.piranha.extension.webxml.internal;
 
-import static cloud.piranha.extension.webxml.WebXml.OTHERS_TAG;
+import static cloud.piranha.extension.webxml.internal.WebXml.OTHERS_TAG;
 import static java.lang.System.Logger.Level.DEBUG;
 import static java.lang.System.Logger.Level.WARNING;
 import static java.util.regex.Pattern.quote;
@@ -55,31 +55,13 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
-import cloud.piranha.extension.webxml.WebXml;
-import cloud.piranha.extension.webxml.WebXmlContextParam;
-import cloud.piranha.extension.webxml.WebXmlDataSource;
-import cloud.piranha.extension.webxml.WebXmlErrorPage;
-import cloud.piranha.extension.webxml.WebXmlFilter;
-import cloud.piranha.extension.webxml.WebXmlFilterInitParam;
-import cloud.piranha.extension.webxml.WebXmlFilterMapping;
-import cloud.piranha.extension.webxml.WebXmlJspConfigTaglib;
-import cloud.piranha.extension.webxml.WebXmlListener;
-import cloud.piranha.extension.webxml.WebXmlLoginConfig;
-import cloud.piranha.extension.webxml.WebXmlMimeMapping;
-import cloud.piranha.extension.webxml.WebXmlSecurityConstraint;
-import cloud.piranha.extension.webxml.WebXmlServlet;
-import cloud.piranha.extension.webxml.WebXmlServletInitParam;
-import cloud.piranha.extension.webxml.WebXmlServletMapping;
-import cloud.piranha.extension.webxml.WebXmlServletMultipartConfig;
-import cloud.piranha.extension.webxml.WebXmlServletSecurityRoleRef;
-import cloud.piranha.extension.webxml.WebXmlSessionConfig;
 
 /**
  * The web.xml / web-fragment.xml parser.
  *
  * @author Manfred Riem (mriem@manorrock.com)
  */
-public class InternalWebXmlParser {
+public class WebXmlParser {
 
     /**
      * Stores the 'location/text()' selector.
@@ -89,7 +71,7 @@ public class InternalWebXmlParser {
     /**
      * Stores the logger.
      */
-    private static final Logger LOGGER = System.getLogger(InternalWebXmlParser.class.getName());
+    private static final Logger LOGGER = System.getLogger(WebXmlParser.class.getName());
 
     /**
      * Stores the 'param-name/text()' selector.

diff --git a/...xml/internal/InternalWebXmlProcessor.java → ...sion/webxml/internal/WebXmlProcessor.java b/...xml/internal/InternalWebXmlProcessor.java → ...sion/webxml/internal/WebXmlProcessor.java
@@ -52,23 +52,9 @@
 import cloud.piranha.core.api.SecurityRoleReference;
 import cloud.piranha.core.api.SecurityWebResourceCollection;
 import cloud.piranha.core.api.WebApplication;
-import cloud.piranha.extension.webxml.WebXml;
-import cloud.piranha.extension.webxml.WebXmlContextParam;
-import cloud.piranha.extension.webxml.WebXmlDataSource;
-import cloud.piranha.extension.webxml.WebXmlErrorPage;
-import cloud.piranha.extension.webxml.WebXmlFilterInitParam;
-import cloud.piranha.extension.webxml.WebXmlJspConfigTaglib;
-import cloud.piranha.extension.webxml.WebXmlListener;
-import cloud.piranha.extension.webxml.WebXmlLoginConfig;
-import cloud.piranha.extension.webxml.WebXmlServlet;
-import cloud.piranha.extension.webxml.WebXmlServletMapping;
-import cloud.piranha.extension.webxml.WebXmlServletMultipartConfig;
-import cloud.piranha.extension.webxml.WebXmlSessionConfig;
 import cloud.piranha.core.api.WelcomeFileManager;
 import cloud.piranha.core.impl.DefaultJspConfigDescriptor;
 import cloud.piranha.core.impl.DefaultTaglibDescriptor;
-import cloud.piranha.extension.webxml.WebXmlSecurityConstraint;
-import cloud.piranha.extension.webxml.WebXmlServletSecurityRoleRef;
 import jakarta.servlet.DispatcherType;
 import jakarta.servlet.FilterRegistration;
 import jakarta.servlet.MultipartConfigElement;
@@ -81,12 +67,12 @@
  *
  * @author Manfred Riem (mriem@manorrock.com)
  */
-public class InternalWebXmlProcessor {
+public class WebXmlProcessor {
 
     /**
      * Stores the logger.
      */
-    private static final Logger LOGGER = System.getLogger(InternalWebXmlProcessor.class.getName());
+    private static final Logger LOGGER = System.getLogger(WebXmlProcessor.class.getName());
 
     /**
      * Stores the empty string array.

diff --git a/...sion/webxml/WebXmlSecurityConstraint.java → ...ml/internal/WebXmlSecurityConstraint.java b/...sion/webxml/WebXmlSecurityConstraint.java → ...ml/internal/WebXmlSecurityConstraint.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...ranha/extension/webxml/WebXmlServlet.java → ...ension/webxml/internal/WebXmlServlet.java b/...ranha/extension/webxml/WebXmlServlet.java → ...ension/webxml/internal/WebXmlServlet.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...ension/webxml/WebXmlServletInitParam.java → ...bxml/internal/WebXmlServletInitParam.java b/...ension/webxml/WebXmlServletInitParam.java → ...bxml/internal/WebXmlServletInitParam.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A servlet init-param inside of web.xml/web-fragment.xml.

diff --git a/...xtension/webxml/WebXmlServletMapping.java → ...webxml/internal/WebXmlServletMapping.java b/...xtension/webxml/WebXmlServletMapping.java → ...webxml/internal/WebXmlServletMapping.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A servlet-mapping inside of web.xml/web-fragment.xml.

diff --git a/.../webxml/WebXmlServletMultipartConfig.java → ...nternal/WebXmlServletMultipartConfig.java b/.../webxml/WebXmlServletMultipartConfig.java → ...nternal/WebXmlServletMultipartConfig.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A servlet multipart-config inside of web.xml/web-fragment.xml.

diff --git a/.../webxml/WebXmlServletSecurityRoleRef.java → ...nternal/WebXmlServletSecurityRoleRef.java b/.../webxml/WebXmlServletSecurityRoleRef.java → ...nternal/WebXmlServletSecurityRoleRef.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A servlet security-role-ref inside of web.xml/web-fragment.xml.

diff --git a/...extension/webxml/WebXmlSessionConfig.java → .../webxml/internal/WebXmlSessionConfig.java b/...extension/webxml/WebXmlSessionConfig.java → .../webxml/internal/WebXmlSessionConfig.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A session-config inside of web.xml or web-fragment.xml.

diff --git a/...bxml/WebXmlSessionConfigCookieConfig.java → ...rnal/WebXmlSessionConfigCookieConfig.java b/...bxml/WebXmlSessionConfigCookieConfig.java → ...rnal/WebXmlSessionConfigCookieConfig.java
@@ -25,7 +25,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package cloud.piranha.extension.webxml;
+package cloud.piranha.extension.webxml.internal;
 
 /**
  * A session-config cookie-config inside of web.xml/web-fragment.xml.