PluginDependenciesResolver.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.plugin.internal;
import java.util.List;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.PluginResolutionException;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.graph.DependencyFilter;
import org.eclipse.aether.graph.DependencyNode;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.resolution.DependencyResult;
/**
* Assists in resolving the dependencies of a plugin. <strong>Warning:</strong> This is an internal utility interface
* that is only public for technical reasons, it is not part of the public API. In particular, this interface can be
* changed or deleted without prior notice.
*
* @since 3.0
*/
public interface PluginDependenciesResolver {
/**
* Resolves the main artifact of the specified plugin.
*
* @param plugin The plugin for which to resolve the main artifact, must not be {@code null}.
* @param repositories The plugin repositories to use for resolving the plugin's main artifact, must not be {@code
* null}.
* @param session The repository session to use for resolving the plugin's main artifact, must not be {@code null}.
* @return The resolved plugin artifact, never {@code null}.
* @throws PluginResolutionException If the plugin artifact could not be resolved.
*/
Artifact resolve(Plugin plugin, List<RemoteRepository> repositories, RepositorySystemSession session)
throws PluginResolutionException;
/**
* Resolves the runtime dependencies of the specified plugin.
*
* @param plugin The plugin for which to resolve the dependencies, must not be {@code null}.
* @param pluginArtifact The plugin's main artifact, may be {@code null}.
* @param dependencyFilter A filter to exclude artifacts from resolution (but not collection), may be {@code null}.
* @param repositories The plugin repositories to use for resolving the plugin artifacts, must not be {@code null}.
* @param session The repository session to use for resolving the plugin artifacts, must not be {@code null}.
* @return The dependency tree denoting the resolved plugin class path, never {@code null}.
* @throws PluginResolutionException If any dependency could not be resolved.
* @deprecated This method should be avoided, as it requires manual flattening; use {@link #resolvePluginAndFlatten(Plugin, Artifact, DependencyFilter, List, RepositorySystemSession)} instead to let Resolver handle it.
*/
@Deprecated
DependencyNode resolve(
Plugin plugin,
Artifact pluginArtifact,
DependencyFilter dependencyFilter,
List<RemoteRepository> repositories,
RepositorySystemSession session)
throws PluginResolutionException;
/**
* Resolves the runtime dependencies of the specified core extension (as {@link Plugin} as GAV carrier).
* <p>
* The default implementation delegates to
* {@link #resolvePlugin(Plugin, Artifact, DependencyFilter, List, RepositorySystemSession)} so that
* implementations written against Maven 4.0.0-rc-5 and earlier keep working. Implementations should override
* this method: unlike the default, a dedicated implementation is expected to read the extension's artifact
* descriptor first, applying relocations and dependency validation.
*
* @param plugin The plugin for which to resolve the dependencies, must not be {@code null}.
* @param dependencyFilter A filter to exclude artifacts from resolution (but not collection), may be {@code null}.
* @param repositories The plugin repositories to use for resolving the plugin artifacts, must not be {@code null}.
* @param session The repository session to use for resolving the plugin artifacts, must not be {@code null}.
* @return The dependency resolution result having the resolved extension class path but also the tree, never {@code null}.
* @throws PluginResolutionException If any dependency could not be resolved.
* @since 3.10.0
*/
default DependencyResult resolveCoreExtensionAndFlatten(
Plugin plugin,
DependencyFilter dependencyFilter,
List<RemoteRepository> repositories,
RepositorySystemSession session)
throws PluginResolutionException {
return resolvePlugin(plugin, null, dependencyFilter, repositories, session);
}
/**
* Resolves the runtime dependencies of the specified plugin.
* <p>
* Implementations must not delegate to
* {@link #resolvePluginAndFlatten(Plugin, Artifact, DependencyFilter, List, RepositorySystemSession)} without
* also overriding it: the default implementation of that method delegates back here.
*
* @param plugin The plugin for which to resolve the dependencies, must not be {@code null}.
* @param artifact The plugin's main artifact, may be {@code null}.
* @param dependencyFilter A filter to exclude artifacts from resolution (but not collection), may be {@code null}.
* @param repositories The plugin repositories to use for resolving the plugin artifacts, must not be {@code null}.
* @param session The repository session to use for resolving the plugin artifacts, must not be {@code null}.
* @return The dependency resolution result having the resolved plugin class path but also the tree, never {@code null}.
* @throws PluginResolutionException If any dependency could not be resolved.
* @since 4.0.0-beta-2
* @deprecated Use {@link #resolvePluginAndFlatten(Plugin, Artifact, DependencyFilter, List, RepositorySystemSession)} instead.
*/
@Deprecated
DependencyResult resolvePlugin(
Plugin plugin,
Artifact artifact,
DependencyFilter dependencyFilter,
List<RemoteRepository> repositories,
RepositorySystemSession session)
throws PluginResolutionException;
/**
* Resolves the runtime dependencies of the specified plugin.
* <p>
* The default implementation delegates to
* {@link #resolvePlugin(Plugin, Artifact, DependencyFilter, List, RepositorySystemSession)}, which this method
* supersedes, so that implementations written against Maven 4.0.0-rc-5 and earlier keep working.
*
* @param plugin The plugin for which to resolve the dependencies, must not be {@code null}.
* @param pluginArtifact The plugin's main artifact, may be {@code null}.
* @param dependencyFilter A filter to exclude artifacts from resolution (but not collection), may be {@code null}.
* @param repositories The plugin repositories to use for resolving the plugin artifacts, must not be {@code null}.
* @param session The repository session to use for resolving the plugin artifacts, must not be {@code null}.
* @return The dependency resolution result having the resolved plugin class path but also the tree, never {@code null}.
* @throws PluginResolutionException If any dependency could not be resolved.
* @since 3.10.0
*/
default DependencyResult resolvePluginAndFlatten(
Plugin plugin,
Artifact pluginArtifact,
DependencyFilter dependencyFilter,
List<RemoteRepository> repositories,
RepositorySystemSession session)
throws PluginResolutionException {
return resolvePlugin(plugin, pluginArtifact, dependencyFilter, repositories, session);
}
}