1 package org.apache.maven.plugin.assembly.artifact;
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 org.apache.maven.artifact.Artifact;
23 import org.apache.maven.artifact.repository.ArtifactRepository;
24 import org.apache.maven.plugin.assembly.AssemblerConfigurationSource;
25 import org.apache.maven.plugin.assembly.AssemblyContext;
26 import org.apache.maven.plugin.assembly.model.Assembly;
27 import org.apache.maven.project.MavenProject;
28
29 /**
30 * Convenience component that aids in the resolution of dependency artifacts, according to various configurations such
31 * as transitivity flag and scope.
32 *
33 * @version $Id: DependencyResolver.java 999612 2010-09-21 20:34:50Z jdcasey $
34 */
35 public interface DependencyResolver
36 {
37
38 /**
39 * Resolve the project dependencies, according to the supplied configuration.
40 *
41 * @param project
42 * The project whose dependencies should be resolved
43 * @param scope
44 * The dependency scope to resolve
45 * @param managedVersions
46 * The map of managed versions, which allows dependency version conflict resolution to happen once for
47 * the entire assembly process.
48 * @param localRepository
49 * The local repository which acts as a local cache for remote artifact repositories
50 * @param remoteRepositories
51 * The list of remote {@link ArtifactRepository} instances to use during resolution, in addition to those
52 * defined in the supplied {@link MavenProject} instance.
53 * @param resolveTransitively
54 * If true, resolve project dependencies transitively; if false, only resolve the project's direct
55 * dependencies.
56 * @return The set of resolved {@link Artifact} instances for the project
57 */
58 // Set<Artifact> resolveDependencies( MavenProject project, String scope, ArtifactRepository localRepository,
59 // List<ArtifactRepository> remoteRepositories, boolean resolveTransitively )
60 // throws InvalidDependencyVersionException, ArtifactResolutionException, ArtifactNotFoundException;
61
62 void resolve( Assembly assembly, AssemblerConfigurationSource configSource, AssemblyContext context )
63 throws DependencyResolutionException;
64
65 }