View Javadoc
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.deployer;
20  
21  import java.io.File;
22  import org.apache.maven.artifact.Artifact;
23  import org.apache.maven.artifact.repository.ArtifactRepository;
24  
25  /**
26   * ArtifactDeployer
27   */
28  public interface ArtifactDeployer {
29      String ROLE = ArtifactDeployer.class.getName();
30  
31      /**
32       * Deploy an artifact from a particular directory. The artifact handler is used to determine the
33       * filename of the source file.
34       *
35       * @param basedir the directory where the artifact is stored
36       * @param finalName the name of the artifact without extension
37       * @param artifact the artifact definition
38       * @param deploymentRepository the repository to deploy to
39       * @param localRepository the local repository to install into
40       * @throws ArtifactDeploymentException if an error occurred deploying the artifact
41       * @deprecated to be removed before 2.0 after the install/deploy plugins use the alternate
42       *             method
43       */
44      @Deprecated
45      void deploy(
46              String basedir,
47              String finalName,
48              Artifact artifact,
49              ArtifactRepository deploymentRepository,
50              ArtifactRepository localRepository)
51              throws ArtifactDeploymentException;
52  
53      /**
54       * Deploy an artifact from a particular file.
55       *
56       * @param source the file to deploy
57       * @param artifact the artifact definition
58       * @param deploymentRepository the repository to deploy to
59       * @param localRepository the local repository to install into
60       * @throws ArtifactDeploymentException if an error occurred deploying the artifact
61       */
62      void deploy(
63              File source, Artifact artifact, ArtifactRepository deploymentRepository, ArtifactRepository localRepository)
64              throws ArtifactDeploymentException;
65  }