1 package org.apache.maven.shared.transfer.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.transfer.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 * @throws IllegalArgumentException in case of parameter <code>buildingRequest</code> is <code>null</code> or
38 * parameter <code>mavenArtifact</code> is <code>null</code>.
39 */
40 ArtifactResult resolveArtifact( ProjectBuildingRequest buildingRequest, Artifact mavenArtifact )
41 throws ArtifactResolverException, IllegalArgumentException;
42
43 /**
44 * @param buildingRequest {@link ProjectBuildingRequest}
45 * @param coordinate {@link ArtifactCoordinate}
46 * @return {@link ArtifactResult}
47 * @throws ArtifactResolverException in case of an error.
48 * @throws IllegalArgumentException in case of parameter <code>buildingRequest</code> is <code>null</code> or
49 * parameter <code>coordinate</code> is <code>null</code>.
50 */
51 ArtifactResult resolveArtifact( ProjectBuildingRequest buildingRequest, ArtifactCoordinate coordinate )
52 throws ArtifactResolverException, IllegalArgumentException;
53
54 // /**
55 // * This will resolve the dependencies of the coordinate, not resolving the the artifact of the coordinate itself.
56 // * If the coordinate needs to be resolved too, use
57 // * {@link #resolveDependencies(ProjectBuildingRequest, Collection, Collection, TransformableFilter)} passing
58 // * {@code Collections.singletonList(coordinate)}
59 // *
60 // * @param buildingRequest {@link ProjectBuildingRequest}
61 // * @param coordinate {@link ArtifactCoordinate}
62 // * @param filter {@link TransformableFilter}
63 // * @return the resolved dependencies.
64 // * @throws ArtifactResolverException in case of an error.
65 // */
66 // Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest, ArtifactCoordinate
67 // coordinate,
68 // TransformableFilter filter )
69 // throws ArtifactResolverException;
70 //
71 // /**
72 // * @param buildingRequest the project building request, never {@code null}
73 // * @param dependencies the dependencies to resolve, never {@code null}
74 // * @param managedDependencies managed dependencies, can be {@code null}
75 // * @param filter a filter, can be {@code null}
76 // * @return the resolved dependencies.
77 // * @throws ArtifactResolverException in case of an error.
78 // */
79 // Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
80 // Collection<Dependency> dependencies,
81 // Collection<Dependency> managedDependencies,
82 // TransformableFilter filter )
83 // throws ArtifactResolverException;
84 }