rulesets.java.j2ee.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of walkmod-pmd-plugin Show documentation
Show all versions of walkmod-pmd-plugin Show documentation
Walkmod plugin to automatically fix the reported problems by PMD
<?xml version="1.0"?>
<ruleset name="J2EE"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<description>
Rules specific to the use of J2EE implementations.
</description>
<rule name="UseProperClassLoader"
language="java"
since="3.7"
message="In J2EE, getClassLoader() might not work as expected. Use Thread.currentThread().getContextClassLoader() instead."
class="net.sourceforge.pmd.lang.rule.XPathRule"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#UseProperClassLoader">
<description>
In J2EE, the getClassLoader() method might not work as expected. Use
Thread.currentThread().getContextClassLoader() instead.
</description>
<priority>3</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//PrimarySuffix[@Image='getClassLoader']
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
public class Foo {
ClassLoader cl = Bar.class.getClassLoader();
}
]]>
</example>
</rule>
<rule
name="MDBAndSessionBeanNamingConvention"
language="java"
since="4.0"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="SessionBean or MessageBean should be suffixed by Bean"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#MDBAndSessionBeanNamingConvention">
<description>
The EJB Specification states that any MessageDrivenBean or SessionBean should be suffixed by 'Bean'.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value><![CDATA[
//TypeDeclaration/ClassOrInterfaceDeclaration
[
(
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'SessionBean')])
or
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'MessageDrivenBean')])
)
and
not
(
ends-with(@Image,'Bean')
)
]
]]></value>
</property>
</properties>
<example>
<![CDATA[
public class SomeBean implements SessionBean{} // proper name
public class MissingTheProperSuffix implements SessionBean {} // non-standard name
]]>
</example>
</rule>
<rule
name="RemoteSessionInterfaceNamingConvention"
language="java"
since="4.0"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="Remote Home interface of a Session EJB should be suffixed by 'Home'"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#RemoteSessionInterfaceNamingConvention">
<description>
A Remote Home interface type of a Session EJB should be suffixed by 'Home'.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceDeclaration
[
(
(./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBHome')])
)
and
not
(
ends-with(@Image,'Home')
)
]
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
public interface MyBeautifulHome extends javax.ejb.EJBHome {} // proper name
public interface MissingProperSuffix extends javax.ejb.EJBHome {} // non-standard name
]]>
</example>
</rule>
<rule
name="LocalInterfaceSessionNamingConvention"
language="java"
since="4.0"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="The Local Interface of a Session EJB should be suffixed by 'Local'"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#LocalInterfaceSessionNamingConvention">
<description>
The Local Interface of a Session EJB should be suffixed by 'Local'.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceDeclaration
[
(
(./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBLocalObject')])
)
and
not
(
ends-with(@Image,'Local')
)
]
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
public interface MyLocal extends javax.ejb.EJBLocalObject {} // proper name
public interface MissingProperSuffix extends javax.ejb.EJBLocalObject {} // non-standard name
]]>
</example>
</rule>
<rule
name="LocalHomeNamingConvention"
language="java"
since="4.0"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="The Local Home interface of a Session EJB should be suffixed by 'LocalHome'"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#LocalHomeNamingConvention">
<description>
The Local Home interface of a Session EJB should be suffixed by 'LocalHome'.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceDeclaration
[
(
(./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBLocalHome')])
)
and
not
(
ends-with(@Image,'LocalHome')
)
]
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
public interface MyBeautifulLocalHome extends javax.ejb.EJBLocalHome {}// proper name
public interface MissingProperSuffix extends javax.ejb.EJBLocalHome {} // non-standard name
]]>
</example>
</rule>
<rule
name="RemoteInterfaceNamingConvention"
language="java"
since="4.0"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="Remote Interface of a Session EJB should NOT be suffixed"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#RemoteInterfaceNamingConvention">
<description>
Remote Interface of a Session EJB should not have a suffix.
</description>
<priority>4</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceDeclaration
[
(
(./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBObject')])
)
and
(
ends-with(@Image,'Session')
or
ends-with(@Image,'EJB')
or
ends-with(@Image,'Bean')
)
]
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
/* Poor Session suffix */
public interface BadSuffixSession extends javax.ejb.EJBObject {}
/* Poor EJB suffix */
public interface BadSuffixEJB extends javax.ejb.EJBObject {}
/* Poor Bean suffix */
public interface BadSuffixBean extends javax.ejb.EJBObject {}
]]>
</example>
</rule>
<rule name="DoNotCallSystemExit"
language="java"
since="4.1"
message="System.exit() should not be used in J2EE/JEE apps"
class="net.sourceforge.pmd.lang.rule.XPathRule"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#DoNotCallSystemExit">
<description>
Web applications should not call System.exit(), since only the web container or the
application server should stop the JVM. This rule also checks for the equivalent call Runtime.getRuntime().exit().
</description>
<priority>3</priority>
<properties>
<property name="xpath">
<value><![CDATA[
//Name[
starts-with(@Image,'System.exit')
or
(starts-with(@Image,'Runtime.getRuntime') and ../../PrimarySuffix[ends-with(@Image,'exit')])
]
]]></value>
</property>
</properties>
<example>
<![CDATA[
public void bar() {
System.exit(0); // never call this when running in an application server!
}
public void foo() {
Runtime.getRuntime().exit(0); // never stop the JVM manually, the container will do this.
}
]]></example>
</rule>
<rule name="StaticEJBFieldShouldBeFinal"
language="java"
since="4.1"
message="EJB's shouldn't have non-final static fields"
class="net.sourceforge.pmd.lang.rule.XPathRule"
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#StaticEJBFieldShouldBeFinal">
<description>
According to the J2EE specification, an EJB should not have any static fields
with write access. However, static read-only fields are allowed. This ensures proper
behavior especially when instances are distributed by the container on several JREs.
</description>
<priority>3</priority>
<properties>
<property name="xpath">
<value><![CDATA[
//ClassOrInterfaceDeclaration[
(
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'SessionBean')])
or
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'EJBHome')])
or
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'EJBLocalObject')])
or
(./ImplementsList/ClassOrInterfaceType[ends-with(@Image,'EJBLocalHome')])
or
(./ExtendsList/ClassOrInterfaceType[ends-with(@Image,'EJBObject')])
)
and
(./ClassOrInterfaceBody/ClassOrInterfaceBodyDeclaration[
(./FieldDeclaration[@Static = 'true'])
and
(./FieldDeclaration[@Final = 'false'])
])
]
]]></value>
</property>
</properties>
<example><![CDATA[
public class SomeEJB extends EJBObject implements EJBLocalHome {
private static int CountA; // poor, field can be edited
private static final int CountB; // preferred, read-only access
}
]]></example>
</rule>
<rule
name="DoNotUseThreads"
language="java"
since="4.1"
class="net.sourceforge.pmd.lang.rule.XPathRule"
message="To be compliant to J2EE, a webapp should not use any thread."
externalInfoUrl="https://pmd.github.io/pmd-5.4.1/pmd-java/rules/java/j2ee.html#DoNotUseThreads">
<description>
<![CDATA[
The J2EE specification explicitly forbids the use of threads.
]]>
</description>
<priority>3</priority>
<properties>
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceType[@Image = 'Thread' or @Image = 'Runnable']
]]>
</value>
</property>
</properties>
<example>
<![CDATA[
// This is not allowed
public class UsingThread extends Thread {
}
// Neither this,
public class OtherThread implements Runnable {
// Nor this ...
public void methode() {
Runnable thread = new Thread(); thread.run();
}
}
]]>
</example>
</rule>
</ruleset>
© 2015 - 2025 Weber Informatics LLC | Privacy Policy