View Javadoc
1   package org.apache.maven.reporting.exec;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.List;
23  
24  import org.apache.maven.execution.MavenSession;
25  import org.apache.maven.model.Plugin;
26  import org.apache.maven.plugin.InvalidPluginDescriptorException;
27  import org.apache.maven.plugin.MavenPluginManager;
28  import org.apache.maven.plugin.PluginContainerException;
29  import org.apache.maven.plugin.PluginDescriptorParsingException;
30  import org.apache.maven.plugin.PluginResolutionException;
31  import org.apache.maven.plugin.descriptor.PluginDescriptor;
32  
33  /**
34   * {@link MavenPluginManager} helper to deal with API changes between Maven 3.0.x and 3.1.x, ie switch from Sonatype Aether
35   * (in <code>org.sonatype.aether</code> package) to Eclipse Aether (in <code>org.eclipse.aether</code> package) for
36   * some parameters.
37   * 
38   * @author Hervé Boutemy
39   * @since 1.1
40   */
41  public interface MavenPluginManagerHelper
42  {
43      /**
44       * Helper for {@link MavenPluginManager#getPluginDescriptor(Plugin, List, org.eclipse.aether.RepositorySystemSession)}
45       * 
46       * @param plugin
47       * @param session
48       * @return
49       * @throws PluginResolutionException
50       * @throws PluginDescriptorParsingException
51       * @throws InvalidPluginDescriptorException
52       */
53      PluginDescriptor getPluginDescriptor( Plugin plugin, MavenSession session )
54          throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException;
55  
56      /**
57       * Helper for {@link MavenPluginManager#setupPluginRealm(PluginDescriptor, MavenSession, ClassLoader, List, org.eclipse.aether.graph.DependencyFilter)
58       * 
59       * @param pluginDescriptor
60       * @param session
61       * @param parent
62       * @param imports
63       * @param excludeArtifactIds
64       * @throws PluginResolutionException
65       * @throws PluginContainerException
66       */
67      void setupPluginRealm( PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader parent,
68                                    List<String> imports, List<String> excludeArtifactIds )
69          throws PluginResolutionException, PluginContainerException;
70  }