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.PluginContainerException;
28 import org.apache.maven.plugin.PluginDescriptorParsingException;
29 import org.apache.maven.plugin.PluginResolutionException;
30 import org.apache.maven.plugin.descriptor.PluginDescriptor;
31
32 /**
33 * {@link org.apache.maven.plugin.MavenPluginManager} helper to deal with API changes between Maven 3.0.x and 3.1.x, ie
34 * switch from Sonatype Aether (in <code>org.sonatype.aether</code> package) to Eclipse Aether (in
35 * <code>org.eclipse.aether</code> package) for some parameters.
36 *
37 * @author Hervé Boutemy
38 * @since 1.1
39 */
40 public interface MavenPluginManagerHelper
41 {
42 /**
43 * Helper for {@link org.apache.maven.plugin.MavenPluginManager#getPluginDescriptor
44 * MavenPluginManager#getPluginDescriptor(Plugin, List, xxx.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 org.apache.maven.plugin.MavenPluginManager#setupPluginRealm
58 * MavenPluginManager#setupPluginRealm(PluginDescriptor, ..., List, xxx.aether.graph.DependencyFilter)}
59 *
60 * @param pluginDescriptor
61 * @param session
62 * @param parent
63 * @param imports
64 * @param excludeArtifactIds
65 * @throws PluginResolutionException
66 * @throws PluginContainerException
67 */
68 void setupPluginRealm( PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader parent,
69 List<String> imports, List<String> excludeArtifactIds )
70 throws PluginResolutionException, PluginContainerException;
71 }