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