org.apache.maven.enforcer.rule.api

Interface EnforcerRule

All Known Subinterfaces:

EnforcerRule2

All Known Implementing Classes:

AbstractBanDependencies, AbstractNonCacheableEnforcerRule, AbstractPropertyEnforcerRule, AbstractRequireFiles, AbstractStandardEnforcerRule, AbstractVersionEnforcer, AlwaysFail, AlwaysPass, BanDistributionManagement, BanDuplicatePomDependencyVersions, BannedDependencies, BannedPlugins, BannedRepositories, BanTransitiveDependencies, DependencyConvergence, EvaluateBeanshell, ReactorModuleConvergence, RequireActiveProfile, RequireEnvironmentVariable, RequireFileChecksum, RequireFilesDontExist, RequireFilesExist, RequireFilesSize, RequireJavaVersion, RequireMavenVersion, RequireNoRepositories, RequireOS, RequirePluginVersions, RequirePrerequisite, RequireProfileIdsExist, RequireProperty, RequireReleaseDeps, RequireReleaseVersion, RequireSameVersions, RequireSnapshotVersion, RequireUpperBoundDeps

public interface EnforcerRule

Interface to be implemented by any rules executed by the enforcer.

Version:

$Id$

Author:

Brian Fox

Method Summary

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.
String	getCacheId() If the rule is to be cached, this id is used as part of the key.
boolean	isCacheable() This method tells the enforcer if the rule results may be cached.
boolean	isResultValid(EnforcerRule cachedRule) If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results.

Method Detail

execute

void execute(@Nonnull
             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

isCacheable

boolean isCacheable()

This method tells the enforcer if the rule results may be cached. If the result is true, the results will be remembered for future executions in the same build (ie children). Subsequent iterations of the rule will be queried to see if they are also cacheable. This will allow the rule to be uncached further down the tree if needed.

Returns:

true if rule is cacheable

isResultValid

boolean isResultValid(@Nonnull
                      EnforcerRule cachedRule)

If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results. Most of the time this can be done by generating unique ids, but sometimes the results of objects returned by the helper need to be queried. You may for example, store certain objects in your rule and then query them later.

Parameters:

cachedRule - the last cached instance of the rule. This is to be used by the rule to potentially determine if the results are still valid (ie if the configuration has been overridden)

Returns:

true if the stored results are valid for the same id.

getCacheId

@Nullable
String getCacheId()

If the rule is to be cached, this id is used as part of the key. This can allow rules to take parameters that allow multiple results of the same rule to be cached.

Returns:

id to be used by the enforcer to determine uniqueness of cache results. The ids only need to be unique within a given rule implementation as the full key will be [classname]-[id]