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