1 package org.apache.maven.artifact.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 org.apache.maven.artifact.Artifact;
23 import org.apache.maven.artifact.deployer.ArtifactDeploymentException;
24 import org.apache.maven.artifact.installer.ArtifactInstallationException;
25 import org.apache.maven.artifact.repository.ArtifactRepository;
26 import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
27 import org.apache.maven.artifact.resolver.ArtifactResolutionException;
28
29 import java.util.List;
30
31 /**
32 * Manages multiple ArtifactTransformation instances and applies them in succession.
33 */
34 public interface ArtifactTransformationManager
35 {
36 String ROLE = ArtifactTransformationManager.class.getName();
37
38 /**
39 * Take in a artifact and return the transformed artifact for locating in the remote repository. If no
40 * transformation has occured the original artifact is returned.
41 *
42 * @param artifact Artifact to be transformed.
43 * @param remoteRepositories the repositories to check
44 * @param localRepository the local repository
45 */
46 void transformForResolve( Artifact artifact, List<ArtifactRepository> remoteRepositories, ArtifactRepository localRepository )
47 throws ArtifactResolutionException, ArtifactNotFoundException;
48
49 /**
50 * Take in a artifact and return the transformed artifact for locating in the local repository. If no
51 * transformation has occured the original artifact is returned.
52 *
53 * @param artifact Artifact to be transformed.
54 * @param localRepository the local repository it will be stored in
55 */
56 void transformForInstall( Artifact artifact, ArtifactRepository localRepository )
57 throws ArtifactInstallationException;
58
59 /**
60 * Take in a artifact and return the transformed artifact for distributing toa remote repository. If no
61 * transformation has occured the original artifact is returned.
62 *
63 * @param artifact Artifact to be transformed.
64 * @param remoteRepository the repository to deploy to
65 * @param localRepository the local repository the metadata is stored in
66 */
67 void transformForDeployment( Artifact artifact, ArtifactRepository remoteRepository,
68 ArtifactRepository localRepository )
69 throws ArtifactDeploymentException;
70
71 }