View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.impl.resolver.relocation;
20  
21  import org.apache.maven.api.di.Named;
22  import org.apache.maven.api.di.Priority;
23  import org.apache.maven.api.di.Singleton;
24  import org.apache.maven.api.model.DistributionManagement;
25  import org.apache.maven.api.model.Model;
26  import org.apache.maven.api.model.Relocation;
27  import org.apache.maven.impl.resolver.MavenArtifactRelocationSource;
28  import org.apache.maven.impl.resolver.RelocatedArtifact;
29  import org.eclipse.aether.RepositorySystemSession;
30  import org.eclipse.aether.artifact.Artifact;
31  import org.eclipse.aether.resolution.ArtifactDescriptorResult;
32  import org.slf4j.Logger;
33  import org.slf4j.LoggerFactory;
34  
35  /**
36   * Relocation source from standard distribution management. This is the "one and only" relocation implementation that
37   * existed in Maven 3 land, uses POM distributionManagement/relocation.
38   * <p>
39   * Note: this component should kick-in last regarding relocations.
40   *
41   * @since 4.0.0
42   */
43  @Singleton
44  @Named(DistributionManagementArtifactRelocationSource.NAME)
45  @Priority(5)
46  public final class DistributionManagementArtifactRelocationSource implements MavenArtifactRelocationSource {
47      public static final String NAME = "distributionManagement";
48      private static final Logger LOGGER = LoggerFactory.getLogger(DistributionManagementArtifactRelocationSource.class);
49  
50      @Override
51      public Artifact relocatedTarget(
52              RepositorySystemSession session, ArtifactDescriptorResult artifactDescriptorResult, Model model) {
53          DistributionManagement distMgmt = model.getDistributionManagement();
54          if (distMgmt != null) {
55              Relocation relocation = distMgmt.getRelocation();
56              if (relocation != null) {
57                  Artifact result = new RelocatedArtifact(
58                          artifactDescriptorResult.getRequest().getArtifact(),
59                          relocation.getGroupId(),
60                          relocation.getArtifactId(),
61                          null,
62                          null,
63                          relocation.getVersion(),
64                          relocation.getMessage());
65                  LOGGER.debug(
66                          "The artifact {} has been relocated to {}: {}",
67                          artifactDescriptorResult.getRequest().getArtifact(),
68                          result,
69                          relocation.getMessage());
70                  return result;
71              }
72          }
73          return null;
74      }
75  }