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