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
23 import org.apache.maven.api.ArtifactCoordinate;
24 import org.apache.maven.api.Service;
25 import org.apache.maven.api.Session;
26 import org.apache.maven.api.annotations.Experimental;
27
28 /**
29 * Resolves the artifact, i.e download the file when required and attach it to the artifact
30 *
31 * @since 4.0.0
32 */
33 @Experimental
34 public interface ArtifactResolver extends Service {
35
36 /**
37 * @param request {@link ArtifactResolverRequest}
38 * @return {@link ArtifactResolverResult}
39 * @throws ArtifactResolverException in case of an error
40 * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or
41 * parameter {@code mavenArtifact} is {@code null} or invalid
42 */
43 ArtifactResolverResult resolve(ArtifactResolverRequest request);
44
45 /**
46 * @param session {@link Session}
47 * @param coordinates array of {@link ArtifactCoordinate}
48 * @return {@link ArtifactResolverResult}
49 * @throws ArtifactResolverException in case of an error.
50 * @throws IllegalArgumentException in case of parameter {@code buildingRequest} is {@code null} or
51 * parameter {@code coordinate} is {@code null} or invalid
52 */
53 default ArtifactResolverResult resolve(Session session, Collection<? extends ArtifactCoordinate> coordinates) {
54 return resolve(ArtifactResolverRequest.build(session, coordinates));
55 }
56 }