1 package org.apache.maven.shared.transfer.artifact.install;
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 java.io.File;
23 import java.util.Collection;
24
25 import org.apache.maven.artifact.Artifact;
26 import org.apache.maven.project.ProjectBuildingRequest;
27
28 /**
29 * @author Robert Scholte
30 */
31 public interface ArtifactInstaller
32 {
33
34 /**
35 * @param request {@link ProjectBuildingRequest}
36 * @param mavenArtifacts {@link Artifact} (no null or empty collection allowed.)
37 * @throws ArtifactInstallerException in case of an error.
38 * @throws IllegalArgumentException in case <code>request</code> is <code>null</code>, <code>mavenArtifacts</code>
39 * is <code>null</code> or <code>mavenArtifacts</code> is empty (<code>mavenArtifacts.isEmpty()</code>
40 * == <code>true</code>).
41 */
42 void install( ProjectBuildingRequest request, Collection<Artifact> mavenArtifacts )
43 throws ArtifactInstallerException, IllegalArgumentException;
44
45 /**
46 * @param request {@link ProjectBuildingRequest}.
47 * @param localRepository The location for the local repository.
48 * @param mavenArtifacts Collection of {@link Artifact MavenArtifacts}
49 * @throws ArtifactInstallerException In case of an error which can be the a given artifact can not be found or the
50 * installation has failed.
51 * @throws IllegalArgumentException in case of parameter <code>request</code> is <code>null</code> or parameter
52 * <code>localRepository</code> is <code>null</code> or <code>localRepository</code> is not a directory
53 * or parameter <code>mavenArtifacts</code> is <code>null</code> or
54 * <code>mavenArtifacts.isEmpty()</code> is <code>true</code>.
55 */
56 void install( ProjectBuildingRequest request, File localRepository, Collection<Artifact> mavenArtifacts )
57 throws ArtifactInstallerException;
58
59 }