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   * Manages multiple ArtifactTransformation instances and applies them in succession.
34   */
35  public interface ArtifactTransformationManager
36  {
37      String ROLE = ArtifactTransformationManager.class.getName();
38  
39      /**
40       * Take in a artifact and return the transformed artifact for locating in the remote repository. If no
41       * transformation has occurred the original artifact is returned.
42       *
43       * @param artifact           Artifact to be transformed.
44       * @param request the repositories to check
45       */
46      void transformForResolve( Artifact artifact, RepositoryRequest request )
47          throws ArtifactResolutionException, ArtifactNotFoundException;
48  
49      /**
50       * Take in a artifact and return the transformed artifact for locating in the remote repository. If no
51       * transformation has occurred the original artifact is returned.
52       *
53       * @param artifact           Artifact to be transformed.
54       * @param remoteRepositories the repositories to check
55       * @param localRepository    the local repository
56       */
57      void transformForResolve( Artifact artifact, List<ArtifactRepository> remoteRepositories,
58                                ArtifactRepository localRepository )
59          throws ArtifactResolutionException, ArtifactNotFoundException;
60  
61      /**
62       * Take in a artifact and return the transformed artifact for locating in the local repository. If no
63       * transformation has occurred the original artifact is returned.
64       *
65       * @param artifact        Artifact to be transformed.
66       * @param localRepository the local repository it will be stored in
67       */
68      void transformForInstall( Artifact artifact, ArtifactRepository localRepository )
69          throws ArtifactInstallationException;
70  
71      /**
72       * Take in a artifact and return the transformed artifact for distributing to a remote repository. If no
73       * transformation has occurred the original artifact is returned.
74       *
75       * @param artifact         Artifact to be transformed.
76       * @param remoteRepository the repository to deploy to
77       * @param localRepository  the local repository the metadata is stored in
78       */
79      void transformForDeployment( Artifact artifact, ArtifactRepository remoteRepository,
80                                   ArtifactRepository localRepository )
81          throws ArtifactDeploymentException;
82  
83      List<ArtifactTransformation> getArtifactTransformations();
84  }