Package com.github.ferstl.maven.pomenforcers

Class PedanticDependencyManagementLocationEnforcer

java.lang.Object

com.github.ferstl.maven.pomenforcers.AbstractPedanticEnforcer

com.github.ferstl.maven.pomenforcers.PedanticDependencyManagementLocationEnforcer

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2

public class PedanticDependencyManagementLocationEnforcer
extends AbstractPedanticEnforcer

Enforces that only a well-defined set of POMs may declare dependency management.

 ### Example
     <rules>
       <dependencyManagementLocation implementation="com.github.ferstl.maven.pomenforcers.PedanticDependencyManagementLocationEnforcer">
         <!-- Only these POMs may declare dependency management -->
         <dependencyManagingPoms>com.example.myproject:parent,com.example.myproject:subparent</dependencyManagingPoms>
       </dependencyManagementLocation>
     </rules>
 

Since:

1.0.0

Enforcer Rule ID:

PedanticEnforcerRule.DEPENDENCY_MANAGEMENT_LOCATION

Constructor Summary

Constructors

Constructor	Description
PedanticDependencyManagementLocationEnforcer()

Method Summary

Modifier and Type	Method	Description
protected void	accept(PedanticEnforcerVisitor visitor)
protected void	doEnforce(ErrorReport report)
protected PedanticEnforcerRule	getDescription()
void	setAllowParentPoms(boolean allowParentPoms)	Indicates whether parent POMs are generally allowed to manage plugins.
void	setDependencyManagingPoms(String dependencyManagingPoms)	Comma separated list of POMs that may declare <dependencyManagement>.

Methods inherited from class com.github.ferstl.maven.pomenforcers.AbstractPedanticEnforcer

execute, getCacheId, getHelper, getLevel, getPom, getProjectModel, isCacheable, isResultValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PedanticDependencyManagementLocationEnforcer

public PedanticDependencyManagementLocationEnforcer()

Method Details

setAllowParentPoms

public void setAllowParentPoms(boolean allowParentPoms)

Indicates whether parent POMs are generally allowed to manage plugins.

Parameters:

allowParentPoms -

Since:

1.2.0

Enforcer Configuration Parameter

Default Value:

false

setDependencyManagingPoms

public void setDependencyManagingPoms(String dependencyManagingPoms)

Comma separated list of POMs that may declare <dependencyManagement>. Each POM has to be defined in the format groupId:artifactId.

Parameters:

dependencyManagingPoms - Comma separated list of POMs that may declare plugin management.

Since:

1.0.0

Enforcer Configuration Parameter

Default Value:

n/a

getDescription

protected PedanticEnforcerRule getDescription()

Specified by:

getDescription in class AbstractPedanticEnforcer

accept

protected void accept(PedanticEnforcerVisitor visitor)

Specified by:

accept in class AbstractPedanticEnforcer

doEnforce

protected void doEnforce(ErrorReport report)

Specified by:

doEnforce in class AbstractPedanticEnforcer