BanDistributionManagement (Apache Maven Enforcer 1.4.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
- - org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
  - - org.apache.maven.plugins.enforcer.BanDistributionManagement

All Implemented Interfaces:

EnforcerRule, EnforcerRule2
```
public class BanDistributionManagement
extends AbstractNonCacheableEnforcerRule
```
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 and Description

BanDistributionManagement()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute(EnforcerRuleHelper helper)` This is the interface into the rule.
`boolean`	`isAllowRepository()`
`boolean`	`isAllowSite()`
`boolean`	`isAllowSnapshotRepository()`
`boolean`	`isIgnoreParent()`
`void`	`setAllowRepository(boolean allowRepository)`
`void`	`setAllowSite(boolean allowSite)`
`void`	`setAllowSnapshotRepository(boolean allowSnapshotRepository)`
`void`	`setIgnoreParent(boolean ignoreParent)`

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BanDistributionManagement
```
public BanDistributionManagement()
```
- Method Detail
  - execute
```
public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException
```
    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 if it should stop or just log the message as a warning.
    
    Parameters:
    helper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.
    
    Throws:
    
    EnforcerRuleException - the enforcer rule exception
  - isIgnoreParent
```
public boolean isIgnoreParent()
```
  - setIgnoreParent
```
public void setIgnoreParent(boolean ignoreParent)
```
  - 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)
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.