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.repository.internal.relocation;
20  
21  import javax.inject.Named;
22  import javax.inject.Singleton;
23  
24  import org.apache.maven.model.DistributionManagement;
25  import org.apache.maven.model.Model;
26  import org.apache.maven.model.Relocation;
27  import org.apache.maven.repository.internal.MavenArtifactRelocationSource;
28  import org.apache.maven.repository.internal.RelocatedArtifact;
29  import org.eclipse.aether.RepositorySystemSession;
30  import org.eclipse.aether.artifact.Artifact;
31  import org.eclipse.aether.resolution.ArtifactDescriptorResult;
32  import org.eclipse.sisu.Priority;
33  import org.slf4j.Logger;
34  import org.slf4j.LoggerFactory;
35  
36  /**
37   * Relocation source from standard distribution management. This is the "one and only" relocation implementation that
38   * existed in Maven 3 land, uses POM distributionManagement/relocation.
39   * <p>
40   * Note: this component should kick-in last regarding relocations.
41   *
42   * @since 4.0.0
43   */
44  @Singleton
45  @Named(DistributionManagementArtifactRelocationSource.NAME)
46  @Priority(5)
47  @SuppressWarnings("checkstyle:MagicNumber")
48  public final class DistributionManagementArtifactRelocationSource implements MavenArtifactRelocationSource {
49      public static final String NAME = "distributionManagement";
50      private static final Logger LOGGER = LoggerFactory.getLogger(DistributionManagementArtifactRelocationSource.class);
51  
52      @Override
53      public Artifact relocatedTarget(
54              RepositorySystemSession session, ArtifactDescriptorResult artifactDescriptorResult, Model model) {
55          DistributionManagement distMgmt = model.getDistributionManagement();
56          if (distMgmt != null) {
57              Relocation relocation = distMgmt.getRelocation();
58              if (relocation != null) {
59                  Artifact result = new RelocatedArtifact(
60                          artifactDescriptorResult.getRequest().getArtifact(),
61                          relocation.getGroupId(),
62                          relocation.getArtifactId(),
63                          null,
64                          null,
65                          relocation.getVersion(),
66                          relocation.getMessage());
67                  LOGGER.debug(
68                          "The artifact {} has been relocated to {}: {}",
69                          artifactDescriptorResult.getRequest().getArtifact(),
70                          result,
71                          relocation.getMessage());
72                  return result;
73              }
74          }
75          return null;
76      }
77  }