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;
20
21 import org.apache.maven.model.Model;
22 import org.eclipse.aether.RepositorySystemSession;
23 import org.eclipse.aether.artifact.Artifact;
24 import org.eclipse.aether.resolution.ArtifactDescriptorException;
25 import org.eclipse.aether.resolution.ArtifactDescriptorResult;
26
27 /**
28 * Maven relocation source.
29 * Note: implementations of this component should avoid the "default" name (has special meaning in Eclipse Sisu) and
30 * explicitly order implementations using Sisu priorities.
31 *
32 * @since 4.0.0
33 */
34 public interface MavenArtifactRelocationSource {
35 /**
36 * Returns {@link Artifact} instance where to relocate to, or {@code null}.
37 *
38 * @param session The session, never {@code null}.
39 * @param result The artifact descriptor result, never {@code null}.
40 * @param model The artifact model, never {@code null}.
41 * @return The {@link Artifact} to relocate to, or {@code null} if no relocation wanted.
42 */
43 Artifact relocatedTarget(RepositorySystemSession session, ArtifactDescriptorResult result, Model model)
44 throws ArtifactDescriptorException;
45 }