Package org.apache.maven.plugin.internal

Class DefaultPluginValidationManager

java.lang.Object

org.apache.maven.eventspy.AbstractEventSpy

org.apache.maven.plugin.internal.DefaultPluginValidationManager

All Implemented Interfaces:

EventSpy, PluginValidationManager

@Singleton
@Named
public final class DefaultPluginValidationManager
extends AbstractEventSpy
implements PluginValidationManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DefaultPluginValidationManager.PluginValidationIssues
private static enum	DefaultPluginValidationManager.ValidationReportLevel

Nested classes/interfaces inherited from interface org.apache.maven.eventspy.EventSpy

EventSpy.Context

Nested classes/interfaces inherited from interface org.apache.maven.plugin.PluginValidationManager

PluginValidationManager.IssueLocality

Field Summary

Fields

Modifier and Type	Field	Description
private static final DefaultPluginValidationManager.ValidationReportLevel	DEFAULT_VALIDATION_LEVEL
(package private) static final Collection<String>	EXPECTED_PROVIDED_SCOPE_EXCLUSIONS_GA	The collection of "G:A" combinations that do NOT belong to Maven Core, hence, should be excluded from "expected in provided scope" type of checks.
private static final Collection<DefaultPluginValidationManager.ValidationReportLevel>	INLINE_VALIDATION_LEVEL
private static final String	ISSUES_KEY
private final org.slf4j.Logger	logger
private static final String	MAVEN_PLUGIN_VALIDATION_EXCLUDES_KEY
private static final String	MAVEN_PLUGIN_VALIDATION_KEY
private static final String	PLUGIN_EXCLUDES_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultPluginValidationManager()

Method Summary

Modifier and Type	Method	Description
private boolean	hasAnythingToReport(Map<String,DefaultPluginValidationManager.PluginValidationIssues> issuesMap, EnumSet<PluginValidationManager.IssueLocality> issueLocalitiesToReport)
private boolean	hasAnythingToReport(DefaultPluginValidationManager.PluginValidationIssues issues, EnumSet<PluginValidationManager.IssueLocality> issueLocalitiesToReport)
private void	mayReportInline(org.eclipse.aether.RepositorySystemSession session, PluginValidationManager.IssueLocality locality, String issue)
private String	mojoInfo(MojoDescriptor mojoDescriptor, Class<?> mojoClass)
void	onEvent(Object event)	Notifies the spy of some build event/operation.
private List<String>	parsePluginExcludes(org.eclipse.aether.RepositorySystemSession session)
private DefaultPluginValidationManager.ValidationReportLevel	parseValidationReportLevel(org.eclipse.aether.RepositorySystemSession session)
private String	pluginDeclaration(MavenSession mavenSession, MojoDescriptor mojoDescriptor)
private ConcurrentHashMap<String,DefaultPluginValidationManager.PluginValidationIssues>	pluginIssues(org.eclipse.aether.RepositorySystemSession session)
private String	pluginKey(String groupId, String artifactId, String version)
private String	pluginKey(MojoDescriptor mojoDescriptor)
private String	pluginKey(org.eclipse.aether.artifact.Artifact pluginArtifact)
void	reportPluginMojoValidationIssue(PluginValidationManager.IssueLocality locality, MavenSession mavenSession, MojoDescriptor mojoDescriptor, Class<?> mojoClass, String issue)	Reports plugin Mojo issues applicable to the Mojo itself.
void	reportPluginValidationIssue(PluginValidationManager.IssueLocality locality, MavenSession mavenSession, MojoDescriptor mojoDescriptor, String issue)	Reports plugin issues applicable to the plugin as a whole.
void	reportPluginValidationIssue(PluginValidationManager.IssueLocality locality, org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact pluginArtifact, String issue)	Reports plugin issues applicable to the plugin as a whole.
private void	reportSessionCollectedValidationIssues(MavenSession mavenSession)
private List<?>	validationPluginExcludes(org.eclipse.aether.RepositorySystemSession session)
private DefaultPluginValidationManager.ValidationReportLevel	validationReportLevel(org.eclipse.aether.RepositorySystemSession session)

Methods inherited from class org.apache.maven.eventspy.AbstractEventSpy

close, init

Methods inherited from class java.lang.Object

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

Field Details

EXPECTED_PROVIDED_SCOPE_EXCLUSIONS_GA

static final Collection<String> EXPECTED_PROVIDED_SCOPE_EXCLUSIONS_GA

The collection of "G:A" combinations that do NOT belong to Maven Core, hence, should be excluded from "expected in provided scope" type of checks.

ISSUES_KEY

private static final String ISSUES_KEY

PLUGIN_EXCLUDES_KEY

private static final String PLUGIN_EXCLUDES_KEY

MAVEN_PLUGIN_VALIDATION_KEY

private static final String MAVEN_PLUGIN_VALIDATION_KEY

See Also:

• Constant Field Values

MAVEN_PLUGIN_VALIDATION_EXCLUDES_KEY

private static final String MAVEN_PLUGIN_VALIDATION_EXCLUDES_KEY

See Also:

• Constant Field Values

DEFAULT_VALIDATION_LEVEL

private static final DefaultPluginValidationManager.ValidationReportLevel DEFAULT_VALIDATION_LEVEL

INLINE_VALIDATION_LEVEL

private static final Collection<DefaultPluginValidationManager.ValidationReportLevel> INLINE_VALIDATION_LEVEL

logger

private final org.slf4j.Logger logger

Constructor Details

DefaultPluginValidationManager

public DefaultPluginValidationManager()

Method Details

onEvent

public void onEvent(Object event)

Description copied from interface: EventSpy

Notifies the spy of some build event/operation.

Specified by:

onEvent in interface EventSpy

Overrides:

onEvent in class AbstractEventSpy

Parameters:

event - The event, never null.

See Also:

• SettingsBuildingRequest
• SettingsBuildingResult
• MavenExecutionRequest
• MavenExecutionResult
• DependencyResolutionRequest
• DependencyResolutionResult
• ExecutionEvent
• RepositoryEvent

validationPluginExcludes

private List<?> validationPluginExcludes(org.eclipse.aether.RepositorySystemSession session)

parsePluginExcludes

private List<String> parsePluginExcludes(org.eclipse.aether.RepositorySystemSession session)

validationReportLevel

private DefaultPluginValidationManager.ValidationReportLevel validationReportLevel(org.eclipse.aether.RepositorySystemSession session)

parseValidationReportLevel

private DefaultPluginValidationManager.ValidationReportLevel parseValidationReportLevel(org.eclipse.aether.RepositorySystemSession session)

pluginKey

private String pluginKey(String groupId,
 String artifactId,
 String version)

pluginKey

private String pluginKey(MojoDescriptor mojoDescriptor)

pluginKey

private String pluginKey(org.eclipse.aether.artifact.Artifact pluginArtifact)

mayReportInline

private void mayReportInline(org.eclipse.aether.RepositorySystemSession session,
 PluginValidationManager.IssueLocality locality,
 String issue)

reportPluginValidationIssue

public void reportPluginValidationIssue(PluginValidationManager.IssueLocality locality,
 org.eclipse.aether.RepositorySystemSession session,
 org.eclipse.aether.artifact.Artifact pluginArtifact,
 String issue)

Description copied from interface: PluginValidationManager

Reports plugin issues applicable to the plugin as a whole.

This method should be used in "early" phase of plugin execution, possibly even when plugin or mojo descriptor does not exist yet. In turn, this method will not record extra information like plugin occurrence or declaration location as those are not yet available.

Specified by:

reportPluginValidationIssue in interface PluginValidationManager

reportPluginValidationIssue

public void reportPluginValidationIssue(PluginValidationManager.IssueLocality locality,
 MavenSession mavenSession,
 MojoDescriptor mojoDescriptor,
 String issue)

Description copied from interface: PluginValidationManager

Reports plugin issues applicable to the plugin as a whole.

This method will record extra information as well, like plugin occurrence or declaration location.

Specified by:

reportPluginValidationIssue in interface PluginValidationManager

reportPluginMojoValidationIssue

public void reportPluginMojoValidationIssue(PluginValidationManager.IssueLocality locality,
 MavenSession mavenSession,
 MojoDescriptor mojoDescriptor,
 Class<?> mojoClass,
 String issue)

Description copied from interface: PluginValidationManager

Reports plugin Mojo issues applicable to the Mojo itself.

This method will record extra information as well, like plugin occurrence or declaration location.

Specified by:

reportPluginMojoValidationIssue in interface PluginValidationManager

reportSessionCollectedValidationIssues

private void reportSessionCollectedValidationIssues(MavenSession mavenSession)

hasAnythingToReport

private boolean hasAnythingToReport(Map<String,DefaultPluginValidationManager.PluginValidationIssues> issuesMap,
 EnumSet<PluginValidationManager.IssueLocality> issueLocalitiesToReport)

hasAnythingToReport

private boolean hasAnythingToReport(DefaultPluginValidationManager.PluginValidationIssues issues,
 EnumSet<PluginValidationManager.IssueLocality> issueLocalitiesToReport)

pluginDeclaration

private String pluginDeclaration(MavenSession mavenSession,
 MojoDescriptor mojoDescriptor)

mojoInfo

private String mojoInfo(MojoDescriptor mojoDescriptor,
 Class<?> mojoClass)

pluginIssues

private ConcurrentHashMap<String,DefaultPluginValidationManager.PluginValidationIssues> pluginIssues(org.eclipse.aether.RepositorySystemSession session)