Package org.apache.maven.enforcer.rules

Class BanDistributionManagement

java.lang.Object

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 a distributionManagement 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 the ignoreParent which is by default turned off (true) which means not to check the parent.

Since:

1.4

Author:

Karl Heinz Marbaise

Constructor Summary

Constructors

Constructor	Description
BanDistributionManagement(org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method	Description
void	execute()	This is the interface into the rule.
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
boolean	isAllowRepository()
boolean	isAllowSite()
boolean	isAllowSnapshotRepository()
void	setAllowRepository(boolean allowRepository)
void	setAllowSite(boolean allowSite)
void	setAllowSnapshotRepository(boolean allowSnapshotRepository)
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
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

Methods inherited from class java.lang.Object

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

Constructor Details

BanDistributionManagement

@Inject
public BanDistributionManagement(org.apache.maven.project.MavenProject project)

Method Details

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 class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

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 String toString()

Overrides:

toString in class Object

setLog

public void setLog(EnforcerLogger log)

Used by EnforcerMojo to inject logger instance

Specified by:

setLog in interface EnforcerRuleBase

Parameters:

log - an EnforcerLogger instance

getLog

public EnforcerLogger getLog()

Provide an EnforcerLogger instance for Rule

NOTICE A logger is not available in constructors.

Returns:

an EnforcerLogger instance