Package org.apache.maven.enforcer.rules

Class 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

    • 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

    • Constructor Detail

      • BanDistributionManagement

        @Inject
public BanDistributionManagement​(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 class AbstractEnforcerRule
        Throws:
        EnforcerRuleException - the enforcer rule exception
        EnforcerRuleError - 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 class java.lang.Object