Fixes #4223 - Move WebXmlXXX classes to web.xml extension (#4224)

piranhacloud · Nov 17, 2024 · cea9c97 · cea9c97
1 parent 6f09225
commit cea9c97
Show file tree

Hide file tree

Showing 36 changed files with 79 additions and 165 deletions.
diff --git a/core/api/src/main/java/cloud/piranha/core/api/WebApplicationManager.java b/core/api/src/main/java/cloud/piranha/core/api/WebApplicationManager.java
@@ -125,13 +125,6 @@ public interface WebApplicationManager {
      */
     ServletRequestManager getServletRequestManager();
 
-    /**
-     * Get the web.xml manager.
-     * 
-     * @return the web.xml manager.
-     */
-    WebXmlManager getWebXmlManager();
-
     /**
      * Get the welcome file manager.
      * 
@@ -216,13 +209,6 @@ public interface WebApplicationManager {
      */
     void setServletRequestManager(ServletRequestManager servletRequestManager);
 
-    /**
-     * Set the web.xml manager.
-     * 
-     * @param webXmlManager the web.xml manager.
-     */
-    void setWebXmlManager(WebXmlManager webXmlManager);
-
     /**
      * Set the welcome file manager.
      * 

diff --git a/core/impl/src/main/java/cloud/piranha/core/impl/DefaultWebApplicationManager.java b/core/impl/src/main/java/cloud/piranha/core/impl/DefaultWebApplicationManager.java
@@ -39,7 +39,6 @@
 import cloud.piranha.core.api.SecurityManager;
 import cloud.piranha.core.api.WelcomeFileManager;
 import cloud.piranha.core.api.WebApplicationManager;
-import cloud.piranha.core.api.WebXmlManager;
 import cloud.piranha.resource.api.ResourceManager;
 import cloud.piranha.resource.impl.DefaultResourceManager;
 import cloud.piranha.core.api.ServletRequestManager;
@@ -111,11 +110,6 @@ public class DefaultWebApplicationManager implements WebApplicationManager {
      */
     protected ServletRequestManager servletRequestManager = new DefaultServletRequestManager();
 
-    /**
-     * Stores the web.xml manager.
-     */
-    protected WebXmlManager webXmlManager;
-
     /**
      * Stores the welcome file manager.
      */
@@ -186,11 +180,6 @@ public ServletRequestManager getServletRequestManager() {
         return servletRequestManager;
     }
 
-    @Override
-    public WebXmlManager getWebXmlManager() {
-        return webXmlManager;
-    }
-
     @Override
     public WelcomeFileManager getWelcomeFileManager() {
         return welcomeFileManager;
@@ -251,11 +240,6 @@ public void setSecurityManager(SecurityManager securityManager) {
         this.securityManager = securityManager;
     }
 
-    @Override
-    public void setWebXmlManager(WebXmlManager webXmlManager) {
-        this.webXmlManager = webXmlManager;
-    }
-
     @Override
     public void setWelcomeFileManager(WelcomeFileManager welcomeFileManager) {
         this.welcomeFileManager = welcomeFileManager;

diff --git a/core/impl/src/test/java/cloud/piranha/core/impl/DefaultWebApplicationManagerTest.java b/core/impl/src/test/java/cloud/piranha/core/impl/DefaultWebApplicationManagerTest.java
@@ -27,8 +27,6 @@
  */
 package cloud.piranha.core.impl;
 
-import cloud.piranha.core.api.WebXml;
-import cloud.piranha.core.api.WebXmlManager;
 import cloud.piranha.core.api.WelcomeFileManager;
 import java.util.List;
 import org.junit.jupiter.api.Test;
@@ -179,21 +177,6 @@ void testGetServletRequestManager() {
         assertNull(manager.getServletRequestManager());
     }
 
-    /**
-     * Test getWebXmlManager method.
-     */
-    @Test
-    void testGetWebXmlManager() {
-        DefaultWebApplicationManager manager = new DefaultWebApplicationManager();
-        assertNull(manager.getWebXmlManager());
-        manager.setWebXmlManager(new WebXmlManager() {
-            @Override
-            public WebXml getWebXml() {
-                return null;
-            }
-        });
-    }
-
     /**
      * Test getWelcomeFileManager method.
      */

diff --git a/extension/exousia/pom.xml b/extension/exousia/pom.xml
@@ -52,5 +52,12 @@
             <artifactId>javassist</artifactId>
             <version>3.29.2-GA</version>
         </dependency>
+        <!-- provided -->
+        <dependency>
+            <groupId>cloud.piranha.extension</groupId>
+            <artifactId>piranha-extension-webxml</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/...n/exousia/src/main/java/cloud/piranha/extension/exousia/AuthorizationPostInitializer.java b/...n/exousia/src/main/java/cloud/piranha/extension/exousia/AuthorizationPostInitializer.java
@@ -51,7 +51,7 @@
 import org.glassfish.exousia.mapping.SecurityRoleRef;
 
 import cloud.piranha.core.api.WebApplication;
-import cloud.piranha.core.api.WebXmlManager;
+import cloud.piranha.extension.webxml.WebXmlManager;
 import jakarta.security.jacc.PolicyConfiguration;
 import jakarta.security.jacc.PolicyContextException;
 import jakarta.servlet.FilterRegistration;
@@ -220,7 +220,7 @@ private List<SecurityConstraint> getConstraintsFromSecurityAnnotations(ServletCo
      * @return the list of security constraints.
      */
     private List<SecurityConstraint> getConstraintsFromWebXml(WebApplication webApplication) {
-        WebXmlManager manager = webApplication.getManager().getWebXmlManager();
+        WebXmlManager manager = (WebXmlManager) webApplication.getAttribute("cloud.piranha.extension.webxml.WebXmlManager");
         return piranhaToExousiaConverter.getConstraintsFromWebXml(manager.getWebXml());
     }
 
@@ -232,7 +232,7 @@ private List<SecurityConstraint> getConstraintsFromWebXml(WebApplication webAppl
      * @throws ServletException when a Servlet error occurs.
      */
     public Map<String, List<SecurityRoleRef>> getSecurityRoleRefsFromWebXml(WebApplication webApplication) throws ServletException {
-        WebXmlManager manager = webApplication.getManager().getWebXmlManager();
+        WebXmlManager manager = (WebXmlManager) webApplication.getAttribute("cloud.piranha.extension.webxml.WebXmlManager");
         return piranhaToExousiaConverter.getSecurityRoleRefsFromWebXml(webApplication.getServletRegistrations().keySet(), manager.getWebXml());
     }
 

diff --git a/...sion/exousia/src/main/java/cloud/piranha/extension/exousia/PiranhaToExousiaConverter.java b/...sion/exousia/src/main/java/cloud/piranha/extension/exousia/PiranhaToExousiaConverter.java
@@ -27,10 +27,10 @@
  */
 package cloud.piranha.extension.exousia;
 
-import cloud.piranha.core.api.WebXmlServletSecurityRoleRef;
-import cloud.piranha.core.api.WebXml;
-import cloud.piranha.core.api.WebXmlSecurityConstraint;
-import cloud.piranha.core.api.WebXmlServlet;
+import cloud.piranha.extension.webxml.WebXmlServletSecurityRoleRef;
+import cloud.piranha.extension.webxml.WebXml;
+import cloud.piranha.extension.webxml.WebXmlSecurityConstraint;
+import cloud.piranha.extension.webxml.WebXmlServlet;
 import jakarta.servlet.ServletSecurityElement;
 import jakarta.servlet.annotation.ServletSecurity;
 import static jakarta.servlet.annotation.ServletSecurity.TransportGuarantee.CONFIDENTIAL;

diff --git a/extension/exousia/src/main/java/module-info.java b/extension/exousia/src/main/java/module-info.java
@@ -45,5 +45,6 @@
     requires cloud.piranha.core.impl;
     requires jakarta.security.jacc;
     requires jakarta.servlet;
+    requires static cloud.piranha.extension.webxml;
     requires transitive org.glassfish.exousia;
 }
diff --git a/extension/webxml/pom.xml b/extension/webxml/pom.xml
@@ -14,10 +14,6 @@
 
     <name>Piranha - Extension - web.xml</name>
 
-    <properties>
-        <argLine></argLine>
-    </properties>
-
     <dependencies>
         <!-- compile -->
         <dependency>
@@ -45,12 +41,6 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>cloud.piranha.extension</groupId>
-            <artifactId>piranha-extension-security-servlet</artifactId>
-            <version>${project.version}</version>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>cloud.piranha.extension</groupId>
             <artifactId>piranha-extension-welcomefile</artifactId>
@@ -86,40 +76,9 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <configuration>
-                    <argLine>@{argLine} --add-opens cloud.piranha.extension.webxml/cloud.piranha.extension.webxml.internal=ALL-UNNAMED</argLine>
+                    <useModulePath>false</useModulePath>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>org.jacoco</groupId>
-                <artifactId>jacoco-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>default-check</id>
-                        <goals>
-                            <goal>check</goal>
-                        </goals>
-                        <configuration>
-                            <rules>
-                                <rule>
-                                    <element>BUNDLE</element>
-                                    <limits>
-                                        <limit>
-                                            <counter>INSTRUCTION</counter>
-                                            <value>COVEREDRATIO</value>
-                                            <minimum>0.80</minimum>
-                                        </limit>
-                                        <limit>
-                                            <counter>CLASS</counter>
-                                            <value>MISSEDCOUNT</value>
-                                            <maximum>0</maximum>
-                                        </limit>
-                                    </limits>
-                                </rule>
-                            </rules>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
         </plugins>
     </build>
 </project>
diff --git a/...n/java/cloud/piranha/core/api/WebXml.java → ...loud/piranha/extension/webxml/WebXml.java b/...n/java/cloud/piranha/core/api/WebXml.java → ...loud/piranha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.io.Serializable;
 import java.util.ArrayList;

diff --git a/.../piranha/core/api/WebXmlContextParam.java → .../extension/webxml/WebXmlContextParam.java b/.../piranha/core/api/WebXmlContextParam.java → .../extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A context-param inside of web.xml/web-fragment.xml.

diff --git a/...ud/piranha/core/api/WebXmlDataSource.java → ...ha/extension/webxml/WebXmlDataSource.java b/...ud/piranha/core/api/WebXmlDataSource.java → ...ha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.HashMap;
 import java.util.Map;

diff --git a/...oud/piranha/core/api/WebXmlErrorPage.java → ...nha/extension/webxml/WebXmlErrorPage.java b/...oud/piranha/core/api/WebXmlErrorPage.java → ...nha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * An error-page inside of web.xml/web-fragment.xml.

diff --git a/.../cloud/piranha/core/api/WebXmlFilter.java → ...iranha/extension/webxml/WebXmlFilter.java b/.../cloud/piranha/core/api/WebXmlFilter.java → ...iranha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...ranha/core/api/WebXmlFilterInitParam.java → ...tension/webxml/WebXmlFilterInitParam.java b/...ranha/core/api/WebXmlFilterInitParam.java → ...tension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A filter init-param inside of web.xml/web-fragment.xml.

diff --git a/...piranha/core/api/WebXmlFilterMapping.java → ...extension/webxml/WebXmlFilterMapping.java b/...piranha/core/api/WebXmlFilterMapping.java → ...extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.ArrayList;
 import java.util.List;

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
@@ -31,8 +31,6 @@
 import cloud.piranha.extension.webxml.internal.InternalWebXmlProcessor;
 import cloud.piranha.extension.webxml.internal.InternalWebXmlManager;
 import cloud.piranha.core.api.WebApplication;
-import cloud.piranha.core.api.WebXml;
-import cloud.piranha.core.api.WebXmlServletMapping;
 import jakarta.servlet.ServletContainerInitializer;
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletException;
@@ -73,7 +71,7 @@ public void onStartup(Set<Class<?>> classes, ServletContext servletContext) thro
         try {
             WebApplication webApplication = (WebApplication) servletContext;
             InternalWebXmlManager manager = new InternalWebXmlManager();
-            webApplication.getManager().setWebXmlManager(manager);
+            webApplication.setAttribute("cloud.piranha.extension.webxml.WebXmlManager", manager);
 
             InternalWebXmlParser parser = new InternalWebXmlParser();
             InputStream inputStream = servletContext.getResourceAsStream("WEB-INF/web.xml");

diff --git a/...oud/piranha/core/api/WebXmlJspConfig.java → ...nha/extension/webxml/WebXmlJspConfig.java b/...oud/piranha/core/api/WebXmlJspConfig.java → ...nha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...ranha/core/api/WebXmlJspConfigTaglib.java → ...tension/webxml/WebXmlJspConfigTaglib.java b/...ranha/core/api/WebXmlJspConfigTaglib.java → ...tension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A taglib inside jsp-config of web.xml/web-fragment.xml.

diff --git a/...loud/piranha/core/api/WebXmlListener.java → ...anha/extension/webxml/WebXmlListener.java b/...loud/piranha/core/api/WebXmlListener.java → ...anha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A listener inside of web.xml/web-fragment.xml.

diff --git a/...d/piranha/core/api/WebXmlLoginConfig.java → ...a/extension/webxml/WebXmlLoginConfig.java b/...d/piranha/core/api/WebXmlLoginConfig.java → ...a/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A login-config inside of web.xml/web-fragment.xml.

diff --git a/...cloud/piranha/core/api/WebXmlManager.java → ...ranha/extension/webxml/WebXmlManager.java b/...cloud/piranha/core/api/WebXmlManager.java → ...ranha/extension/webxml/WebXmlManager.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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * The WebXmlManager API.

diff --git a/...d/piranha/core/api/WebXmlMimeMapping.java → ...a/extension/webxml/WebXmlMimeMapping.java b/...d/piranha/core/api/WebXmlMimeMapping.java → ...a/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A mime-mapping inside of web.xml/web-fragment.xml.

diff --git a/...ha/core/api/WebXmlSecurityConstraint.java → ...sion/webxml/WebXmlSecurityConstraint.java b/...ha/core/api/WebXmlSecurityConstraint.java → ...sion/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...cloud/piranha/core/api/WebXmlServlet.java → ...ranha/extension/webxml/WebXmlServlet.java b/...cloud/piranha/core/api/WebXmlServlet.java → ...ranha/extension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/...anha/core/api/WebXmlServletInitParam.java → ...ension/webxml/WebXmlServletInitParam.java b/...anha/core/api/WebXmlServletInitParam.java → ...ension/webxml/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.core.api;
+package cloud.piranha.extension.webxml;
 
 /**
  * A servlet init-param inside of web.xml/web-fragment.xml.