View Javadoc

1   package org.apache.maven.repository.legacy.resolver.transform;
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.util.List;
23  
24  import org.apache.maven.artifact.Artifact;
25  import org.apache.maven.artifact.deployer.ArtifactDeploymentException;
26  import org.apache.maven.artifact.installer.ArtifactInstallationException;
27  import org.apache.maven.artifact.repository.ArtifactRepository;
28  import org.apache.maven.artifact.repository.RepositoryRequest;
29  import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
30  import org.apache.maven.artifact.resolver.ArtifactResolutionException;
31  
32  /**
33   * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
34   * @version $Id: ArtifactTransformation.java 1061325 2011-01-20 14:52:52Z bentmann $
35   */
36  public interface ArtifactTransformation
37  {
38      String ROLE = ArtifactTransformation.class.getName();
39  
40      /**
41       * Take in a artifact and return the transformed artifact for locating in the remote repository. If no
42       * transformation has occured the original artifact is returned.
43       *
44       * @param artifact           Artifact to be transformed.
45       * @param request the repositories to check
46       * @param localRepository    the local repository
47       */
48      void transformForResolve( Artifact artifact, RepositoryRequest request )
49          throws ArtifactResolutionException, ArtifactNotFoundException;
50  
51      /**
52       * Take in a artifact and return the transformed artifact for locating in the remote repository. If no
53       * transformation has occured the original artifact is returned.
54       *
55       * @param artifact           Artifact to be transformed.
56       * @param remoteRepositories the repositories to check
57       * @param localRepository    the local repository
58       */
59      void transformForResolve( Artifact artifact,
60                                List<ArtifactRepository> remoteRepositories,
61                                ArtifactRepository localRepository )
62          throws ArtifactResolutionException, ArtifactNotFoundException;
63  
64      /**
65       * Take in a artifact and return the transformed artifact for locating in the local repository. If no
66       * transformation has occured the original artifact is returned.
67       *
68       * @param artifact        Artifact to be transformed.
69       * @param localRepository the local repository it will be stored in
70       */
71      void transformForInstall( Artifact artifact,
72                                ArtifactRepository localRepository )
73          throws ArtifactInstallationException;
74  
75      /**
76       * Take in a artifact and return the transformed artifact for distributing toa remote repository. If no
77       * transformation has occured the original artifact is returned.
78       *
79       * @param artifact         Artifact to be transformed.
80       * @param remoteRepository the repository to deploy to
81       * @param localRepository  the local repository
82       */
83      void transformForDeployment( Artifact artifact,
84                                   ArtifactRepository remoteRepository,
85                                   ArtifactRepository localRepository )
86          throws ArtifactDeploymentException;
87  
88  }