Class ExternalRules

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleConfigProvider
org.apache.maven.enforcer.rules.ExternalRules
All Implemented Interfaces:
EnforcerRuleBase
@Named("externalRules") public final class ExternalRules extends AbstractEnforcerRuleConfigProvider
An enforcer rule that will provide rules configuration from an external resource.
Since:
3.2.0

  • Field Details

    • LOCATION_PREFIX_CLASSPATH

      private static final String LOCATION_PREFIX_CLASSPATH
      See Also:

    • location

      private String location
      The external rules location. If it starts with classpath: the resource is read from the classpath. Otherwise, it is handled as a filesystem path, either absolute, or relative to ${project.basedir}
      Since:
      3.2.0

    • xsltLocation

      private String xsltLocation
      An optional location of an XSLT file used to transform the rule document available via location before it is applied. If it starts with classpath: the resource is read from the classpath. Otherwise, it is handled as a filesystem path, either absolute, or relative to ${project.basedir}

      This is useful, when you want to consume rules defined in an external project, but you need to remove or adapt some of those for the local circumstances.

      Example

      If location points at the following rule set: 

      <enforcer>
  <rules>
    <bannedDependencies>
       <excludes>
         <exclude>com.google.code.findbugs:jsr305</exclude>
         <exclude>com.google.guava:listenablefuture</exclude>
       </excludes>
    </bannedDependencies>
  </rules>
</enforcer>
      And if xsltLocation points at the following transformation 
      <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output omit-xml-declaration="yes"/>

  <!-- Copy everything unless there is a template with a more specific matcher -->
  <xsl:template match="node()|@*">
    <xsl:copy>
      <xsl:apply-templates select="node()|@*"/>
    </xsl:copy>
  </xsl:template>

  <!-- An empty template will effectively remove the matching nodes -->
  <xsl:template match=
"//bannedDependencies/excludes/exclude[contains(text(), 'com.google.code.findbugs:jsr305')]"/>
</xsl:stylesheet>
      Then the effective rule set will look like to following: 
      <enforcer>
  <rules>
    <bannedDependencies>
       <excludes>
         <exclude>com.google.guava:listenablefuture</exclude>
       </excludes>
    </bannedDependencies>
  </rules>
</enforcer>
      Since:
      3.6.0

    • mojoExecution

      private final org.apache.maven.plugin.MojoExecution mojoExecution

    • evaluator

      private final ExpressionEvaluator evaluator

  • Constructor Details

    • ExternalRules

      @Inject public ExternalRules(org.apache.maven.plugin.MojoExecution mojoExecution, ExpressionEvaluator evaluator)

  • Method Details