1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugin;
20
21 import org.apache.maven.execution.MavenSession;
22 import org.apache.maven.plugin.descriptor.MojoDescriptor;
23 import org.eclipse.aether.RepositorySystemSession;
24 import org.eclipse.aether.artifact.Artifact;
25
26 /**
27 * Component collecting plugin validation issues and reporting them.
28 *
29 * @since 3.9.2
30 */
31 public interface PluginValidationManager {
32 /**
33 * Reports plugin issues applicable to the plugin as a whole.
34 * <p>
35 * This method should be used in "early" phase of plugin execution, possibly even when plugin or mojo descriptor
36 * does not exist yet. In turn, this method will not record extra information like plugin occurrence or declaration
37 * location as those are not yet available.
38 */
39 void reportPluginValidationIssue(RepositorySystemSession session, Artifact pluginArtifact, String issue);
40
41 /**
42 * Reports plugin issues applicable to the plugin as a whole.
43 * <p>
44 * This method will record extra information as well, like plugin occurrence or declaration location.
45 */
46 void reportPluginValidationIssue(MavenSession mavenSession, MojoDescriptor mojoDescriptor, String issue);
47
48 /**
49 * Reports plugin Mojo issues applicable to the Mojo itself.
50 * <p>
51 * This method will record extra information as well, like plugin occurrence or declaration location.
52 */
53 void reportPluginMojoValidationIssue(
54 MavenSession mavenSession, MojoDescriptor mojoDescriptor, Class<?> mojoClass, String issue);
55 }