src/main/java/org/apache/maven/reporting/exec/MavenPluginManagerHelper.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.reporting.exec;

import java.util.List;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.InvalidPluginDescriptorException;
import org.apache.maven.plugin.PluginContainerException;
import org.apache.maven.plugin.PluginDescriptorParsingException;
import org.apache.maven.plugin.PluginResolutionException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;

/**
 * {@link org.apache.maven.plugin.MavenPluginManager} helper to deal with API changes between Maven 3.0.x and 3.1.x, ie
 * switch from Sonatype Aether (in <code>org.sonatype.aether</code> package) to Eclipse Aether (in
 * <code>org.eclipse.aether</code> package) for some parameters.
 *
 * @author Hervé Boutemy
 * @since 1.1
 */
public interface MavenPluginManagerHelper {
    /**
     * Helper for {@link org.apache.maven.plugin.MavenPluginManager#getPluginDescriptor
     * MavenPluginManager#getPluginDescriptor(Plugin, List, xxx.aether.RepositorySystemSession)}
     *
     * @param plugin the plugin
     * @param session the session
     * @return the plugin descriptor
     * @throws PluginResolutionException on resolution issue
     * @throws PluginDescriptorParsingException on descriptor parsing issue
     * @throws InvalidPluginDescriptorException on invalid descriptor
     */
    PluginDescriptor getPluginDescriptor(Plugin plugin, MavenSession session)
            throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException;

    /**
     * Helper for {@link org.apache.maven.plugin.MavenPluginManager#setupPluginRealm
     * MavenPluginManager#setupPluginRealm(PluginDescriptor, ..., List, xxx.aether.graph.DependencyFilter)}
     *
     * @param pluginDescriptor the plugin descriptor
     * @param session the session
     * @param parent the parent classloader
     * @param imports classloader imports
     * @param excludeArtifactIds artifacts excluded from classloader
     * @throws PluginResolutionException on resolution issue
     * @throws PluginContainerException on issue with configuration
     */
    void setupPluginRealm(
            PluginDescriptor pluginDescriptor,
            MavenSession session,
            ClassLoader parent,
            List<String> imports,
            List<String> excludeArtifactIds)
            throws PluginResolutionException, PluginContainerException;
}