MIR-1434 ensure usage of MCRResourceResolver

Author: toKrause

mir-module/src/main/java/org/mycore/mir/common/MIRCoreVersion.java

@@ -36,6 +36,7 @@
  * @author Thomas Scheffler (yagee)
  *
  */
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MIRCoreVersion {
     private static Properties prop = loadVersionProperties();
 

mir-module/src/main/java/org/mycore/mir/migration/MIRMigration03Utils.java

@@ -20,6 +20,7 @@
  */
 @MCRCommandGroup(
     name = "MIR migration 0.3")
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MIRMigration03Utils {
 
     private static final Logger LOGGER = LogManager.getLogger();

mir-module/src/main/java/org/mycore/mir/migration/MIRMigration04Utils.java

@@ -16,6 +16,7 @@
  */
 @MCRCommandGroup(
     name = "MIR migration 0.4")
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MIRMigration04Utils {
 
     private static final Logger LOGGER = LogManager.getLogger();

mir-module/src/main/java/org/mycore/mir/migration/MIRMigration201603Utils.java

@@ -19,6 +19,7 @@
  */
 @MCRCommandGroup(
     name = "MIR migration 2016.03")
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MIRMigration201603Utils {
 
     private static final Logger LOGGER = LogManager.getLogger();

mir-module/src/main/java/org/mycore/mir/migration/MIRMigration201706Utils.java

@@ -23,6 +23,7 @@
 
 @MCRCommandGroup(
     name = "MIR migration 2017.06")
+@SuppressWarnings("PMD.MCR.ResourceResolver")
 public class MIRMigration201706Utils {
 
     private static final Logger LOGGER = LogManager.getLogger();

rules.xml

@@ -12,6 +12,12 @@
         message="The serialVersionUID should be annotated with @java.io.Serial"
         class="net.sourceforge.pmd.lang.rule.xpath.XPathRule">
     <priority>4</priority>
+    <description>
+      Field should look like this:
+
+      @Serial
+      private static final long serialVersionUID = 1L;
+    </description>
     <properties>
       <property name="xpath">
         <value>
@@ -42,6 +48,12 @@
         message="The serialVersionUID should have literal value '1L'"
         class="net.sourceforge.pmd.lang.rule.xpath.XPathRule">
     <priority>4</priority>
+    <description>
+      Field should look like this:
+
+      @Serial
+      private static final long serialVersionUID = 1L;
+    </description>
     <properties>
       <property name="xpath">
         <value>
@@ -67,4 +79,49 @@
     </properties>
   </rule>
 
+  <rule name="MCR.ResourceResolver"
+        language="java"
+        message="Resources should be accessed using MCRResourceResolver or MCRResourceHelper"
+        class="net.sourceforge.pmd.lang.rule.xpath.XPathRule">
+    <description>
+      Accessing resources directly via Class, ClassLoader or ServletContext should only be done
+      - in classes that are part of the setup of the MyCoRe application (e.g. MCRConfigurationInputStream, MCRComponent),
+      - in classes that are used by MCRResourceResolver (e.g. MCRResourceProvider, MCRResourceLocator) or
+      - in rare cases where module specific files need to be accessed (e.g. MCRCoreVersion accessing git.properties).
+      Otherwise, MCRResourceResolver or MCRResourceHelper should be used.
+    </description>
+    <priority>1</priority>
+    <properties>
+      <property name="xpath">
+        <value>
+          <![CDATA[
+            //(MethodCall|MethodReference)
+              [*[position() = 1 and pmd-java:typeIs('java.lang.Class')]]
+              [@MethodName=(
+                'getResource',
+                'getResourceAsStream'
+              )]
+              |
+            //(MethodCall|MethodReference)
+              [*[position() = 1 and pmd-java:typeIs('java.lang.ClassLoader')]]
+              [@MethodName=(
+                'resources',
+                'getResource',
+                'getResources',
+                'getResourceAsStream'
+              )]
+              |
+            //(MethodCall|MethodReference)
+              [*[position() = 1 and pmd-java:typeIs('jakarta.servlet.ServletContext')]]
+              [@MethodName=(
+                'getResource',
+                'getResourcePaths',
+                'getResourceAsStream'
+              )]
+          ]]>
+        </value>
+      </property>
+    </properties>
+  </rule>
+
 </ruleset>