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 org.apache.maven.artifact.Artifact;
23  import org.apache.maven.artifact.repository.ArtifactRepository;
24  
25  import java.io.File;
26  
27  public interface ArtifactDeployer
28  {
29      String ROLE = ArtifactDeployer.class.getName();
30  
31      /**
32       * Deploy an artifact from a particular directory. The artifact handler is used to determine the filename
33       * 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 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 instlal/deploy plugins use the alternate method
42       */
43      void deploy( String basedir, String finalName, Artifact artifact, ArtifactRepository deploymentRepository,
44                   ArtifactRepository localRepository )
45          throws ArtifactDeploymentException;
46  
47      /**
48       * Deploy an artifact from a particular file.
49       *
50       * @param source the file to deploy
51       * @param artifact the artifact definition
52       * @param deploymentRepository the repository to deploy to
53       * @param localRepository the local repository to install into
54       * @throws ArtifactDeploymentException if an error occurred deploying the artifact
55       */
56      void deploy( File source, Artifact artifact, ArtifactRepository deploymentRepository,
57                   ArtifactRepository localRepository )
58          throws ArtifactDeploymentException;
59  }