Package org.apache.maven.enforcer.rules

Class BannedPlugins

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.BannedPlugins

All Implemented Interfaces:

EnforcerRuleBase

@Named("bannedPlugins")
public final class BannedPlugins
extends AbstractStandardEnforcerRule

This rule checks that lists of plugins are not included.

Author:

Marvin Froeder

Constructor Summary

Constructors

Constructor	Description
BannedPlugins(org.apache.maven.execution.MavenSession session)

Method Summary

Modifier and Type	Method	Description
void	execute()	This is the interface into the rule.
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
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

BannedPlugins

@Inject
public BannedPlugins(org.apache.maven.execution.MavenSession session)

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

EnforcerRuleError - in order to brake a build immediately

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