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.Collections;
23 import org.apache.maven.api.Artifact;
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 * Installs {@link Artifact}s to the local repository.
30 *
31 * @since 4.0
32 * @see Session#withLocalRepository(org.apache.maven.api.LocalRepository)
33 */
34 @Experimental
35 public interface ArtifactInstaller extends Service {
36 /**
37 * @param request {@link ArtifactInstallerRequest}
38 * @throws ArtifactInstallerException in case of an error
39 * @throws IllegalArgumentException in case {@code request} is {@code null}
40 */
41 void install(ArtifactInstallerRequest request);
42
43 /**
44 * @param session the repository session
45 * @param artifact the {@link Artifact} to install
46 * @throws ArtifactInstallerException In case of an error which can be the a given artifact cannot be found or the
47 * installation has failed.
48 * @throws IllegalArgumentException in case of parameter {@code session} is {@code null} or
49 * {@code artifact} is {@code null}.
50 */
51 default void install(Session session, Artifact artifact) {
52 install(session, Collections.singletonList(artifact));
53 }
54
55 /**
56 * @param session the repository session
57 * @param artifacts Collection of {@link Artifact MavenArtifacts}
58 * @throws ArtifactInstallerException In case of an error which can be the a given artifact cannot be found or the
59 * installation has failed.
60 * @throws IllegalArgumentException in case of parameter {@code request} is {@code null} or parameter
61 * {@code localRepository} is {@code null} or {@code localRepository} is not a directory
62 * or parameter {@code mavenArtifacts} is {@code null} or
63 * {@code mavenArtifacts.isEmpty()} is {@code true}.
64 */
65 default void install(Session session, Collection<Artifact> artifacts) {
66 install(ArtifactInstallerRequest.build(session, artifacts));
67 }
68 }