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.artifact.installer;
20
21 import java.io.File;
22 import org.apache.maven.artifact.Artifact;
23 import org.apache.maven.artifact.repository.ArtifactRepository;
24
25 /**
26 * @author <a href="michal@codehaus.org">Michal Maczka</a>
27 */
28 public interface ArtifactInstaller {
29 String ROLE = ArtifactInstaller.class.getName();
30
31 /**
32 * Install an artifact from a particular directory. The artifact handler is used to determine
33 * the filename of the source file.
34 *
35 * @param basedir the directory where the artifact is stored
36 * @param finalName the name of the artifact sans extension
37 * @param artifact the artifact definition
38 * @param localRepository the local repository to install into
39 * @throws ArtifactInstallationException if an error occurred installing the artifact
40 * @deprecated to be removed before 2.0 after the install/deploy plugins use the alternate
41 * method
42 */
43 @Deprecated
44 void install(String basedir, String finalName, Artifact artifact, ArtifactRepository localRepository)
45 throws ArtifactInstallationException;
46
47 /**
48 * Install an artifact from a particular file.
49 *
50 * @param source the file to install
51 * @param artifact the artifact definition
52 * @param localRepository the local repository to install into
53 * @throws ArtifactInstallationException if an error occurred installing the artifact
54 */
55 void install(File source, Artifact artifact, ArtifactRepository localRepository)
56 throws ArtifactInstallationException;
57 }