View Javadoc
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.internal;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import org.apache.maven.execution.MavenSession;
26  import org.apache.maven.plugin.PluginValidationManager;
27  import org.apache.maven.plugin.descriptor.MojoDescriptor;
28  import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
29  import org.codehaus.plexus.configuration.PlexusConfiguration;
30  
31  import static java.util.Objects.requireNonNull;
32  
33  /**
34   * Verify that plugin descriptor does not contain Plexus Component requirements.
35   *
36   * @since 3.10.0
37   */
38  @Singleton
39  @Named
40  class PluginDescriptorRequirementsValidator implements MavenPluginConfigurationValidator {
41  
42      private final PluginValidationManager pluginValidationManager;
43  
44      @Inject
45      PluginDescriptorRequirementsValidator(PluginValidationManager pluginValidationManager) {
46          this.pluginValidationManager = requireNonNull(pluginValidationManager);
47      }
48  
49      @Override
50      public void validate(
51              MavenSession mavenSession,
52              MojoDescriptor mojoDescriptor,
53              Class<?> mojoClass,
54              PlexusConfiguration pomConfiguration,
55              ExpressionEvaluator expressionEvaluator) {
56          if (!mojoDescriptor.getRequirements().isEmpty()) {
57              pluginValidationManager.reportPluginMojoValidationIssue(
58                      PluginValidationManager.IssueLocality.EXTERNAL,
59                      mavenSession,
60                      mojoDescriptor,
61                      mojoClass,
62                      "Plugin uses Plexus Component requirements (@Component annotation). "
63                              + "Use Maven 4 Dependency Injection (for v4 plugins) or JSR 330 annotations (for v3 plugins) to inject dependencies instead.");
64          }
65      }
66  }