1 package org.apache.maven.shared.artifact.resolve;
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.project.ProjectBuildingRequest;
24 import org.apache.maven.shared.artifact.ArtifactCoordinate;
25
26 /**
27 * Resolves the artifact, i.e download the file when required and attach it to the artifact
28 */
29 public interface ArtifactResolver
30 {
31
32 /**
33 * @param buildingRequest {@link ProjectBuildingRequest}
34 * @param mavenArtifact {@link Artifact}
35 * @return {@link ArtifactResult}
36 * @throws ArtifactResolverException in case of an error.
37 */
38 ArtifactResult resolveArtifact( ProjectBuildingRequest buildingRequest, Artifact mavenArtifact )
39 throws ArtifactResolverException;
40
41 /**
42 * @param buildingRequest {@link ProjectBuildingRequest}
43 * @param coordinate {@link ArtifactCoordinate}
44 * @return {@link ArtifactResult}
45 * @throws ArtifactResolverException in case of an error.
46 */
47 ArtifactResult resolveArtifact( ProjectBuildingRequest buildingRequest, ArtifactCoordinate coordinate )
48 throws ArtifactResolverException;
49
50 // /**
51 // * This will resolve the dependencies of the coordinate, not resolving the the artifact of the coordinate itself.
52 // * If the coordinate needs to be resolved too, use
53 // * {@link #resolveDependencies(ProjectBuildingRequest, Collection, Collection, TransformableFilter)} passing
54 // * {@code Collections.singletonList(coordinate)}
55 // *
56 // * @param buildingRequest {@link ProjectBuildingRequest}
57 // * @param coordinate {@link ArtifactCoordinate}
58 // * @param filter {@link TransformableFilter}
59 // * @return the resolved dependencies.
60 // * @throws ArtifactResolverException in case of an error.
61 // */
62 // Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest, ArtifactCoordinate coordinate,
63 // TransformableFilter filter )
64 // throws ArtifactResolverException;
65 //
66 // /**
67 // * @param buildingRequest the project building request, never {@code null}
68 // * @param dependencies the dependencies to resolve, never {@code null}
69 // * @param managedDependencies managed dependencies, can be {@code null}
70 // * @param filter a filter, can be {@code null}
71 // * @return the resolved dependencies.
72 // * @throws ArtifactResolverException in case of an error.
73 // */
74 // Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
75 // Collection<Dependency> dependencies,
76 // Collection<Dependency> managedDependencies,
77 // TransformableFilter filter )
78 // throws ArtifactResolverException;
79 }