Package org.apache.maven.enforcer.rules
Class BanDistributionManagement
- java.lang.Object
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
-
- org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
-
- org.apache.maven.enforcer.rules.BanDistributionManagement
-
- All Implemented Interfaces:
EnforcerRuleBase
@Named("banDistributionManagement") public final class BanDistributionManagement extends AbstractStandardEnforcerRule
This rule will check if a pom contains adistributionManagement
part. This should be by best practice only defined once. It could happen that you like to check the parent as well. This can be activated by using theignoreParent
which is by default turned off (true
) which means not to check the parent.- Since:
- 1.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
BanDistributionManagement.DistributionManagementCheck
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowRepository
Allow using a repository entry in the distributionManagement area.private boolean
allowSite
Allow site entry in the distributionManagement area.private boolean
allowSnapshotRepository
Allow snapshotRepository entry in the distributionManagement area.private org.apache.maven.project.MavenProject
project
-
Constructor Summary
Constructors Constructor Description BanDistributionManagement(org.apache.maven.project.MavenProject project)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
This is the interface into the rule.boolean
isAllowRepository()
boolean
isAllowSite()
boolean
isAllowSnapshotRepository()
void
setAllowRepository(boolean allowRepository)
void
setAllowSite(boolean allowSite)
void
setAllowSnapshotRepository(boolean allowSnapshotRepository)
java.lang.String
toString()
-
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
Field Detail
-
allowRepository
private boolean allowRepository
Allow using a repository entry in the distributionManagement area.
-
allowSnapshotRepository
private boolean allowSnapshotRepository
Allow snapshotRepository entry in the distributionManagement area.
-
allowSite
private boolean allowSite
Allow site entry in the distributionManagement area.
-
project
private final org.apache.maven.project.MavenProject project
-
-
Method Detail
-
execute
public void execute() throws EnforcerRuleException
Description copied from class:AbstractEnforcerRule
This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.- Specified by:
execute
in classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- in order to brake a build immediately
-
isAllowRepository
public boolean isAllowRepository()
-
setAllowRepository
public void setAllowRepository(boolean allowRepository)
-
isAllowSnapshotRepository
public boolean isAllowSnapshotRepository()
-
setAllowSnapshotRepository
public void setAllowSnapshotRepository(boolean allowSnapshotRepository)
-
isAllowSite
public boolean isAllowSite()
-
setAllowSite
public void setAllowSite(boolean allowSite)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-