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