1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import java.util.Collection;
22 import java.util.List;
23
24 import org.apache.maven.api.ArtifactCoordinates;
25 import org.apache.maven.api.RemoteRepository;
26 import org.apache.maven.api.Service;
27 import org.apache.maven.api.Session;
28 import org.apache.maven.api.annotations.Experimental;
29
30 /**
31 * Resolves the artifact, i.e. download the file when required and attach it to the artifact
32 *
33 * @since 4.0.0
34 */
35 @Experimental
36 public interface ArtifactResolver extends Service {
37
38 /**
39 * @param request {@link ArtifactResolverRequest}
40 * @return {@link ArtifactResolverResult}
41 * @throws ArtifactResolverException in case of an error
42 * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or
43 * parameter {@code mavenArtifact} is {@code null} or invalid
44 */
45 ArtifactResolverResult resolve(ArtifactResolverRequest request);
46
47 /**
48 * Resolves several artifacts from their coordinates.
49 *
50 * @param session {@link Session}
51 * @param coordinates array of {@link ArtifactCoordinates}
52 * @return {@link ArtifactResolverResult}
53 * @throws ArtifactResolverException in case of an error.
54 * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or
55 * parameter {@code coordinates} is {@code null} or invalid
56 */
57 default ArtifactResolverResult resolve(Session session, Collection<? extends ArtifactCoordinates> coordinates) {
58 return resolve(ArtifactResolverRequest.build(session, coordinates));
59 }
60
61 /**
62 * Resolves several artifacts from their coordinates.
63 *
64 * @param session {@link Session}
65 * @param repositories the list of remote repositories or {@code null} to use the session repositories
66 * @param coordinates array of {@link ArtifactCoordinates}
67 * @return {@link ArtifactResolverResult}
68 * @throws ArtifactResolverException in case of an error.
69 * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or
70 * parameter {@code coordinates} is {@code null} or invalid
71 */
72 default ArtifactResolverResult resolve(
73 Session session,
74 Collection<? extends ArtifactCoordinates> coordinates,
75 List<RemoteRepository> repositories) {
76 return resolve(ArtifactResolverRequest.build(session, coordinates, repositories));
77 }
78 }