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;
20  
21  import java.util.List;
22  import org.apache.maven.artifact.repository.ArtifactRepository;
23  import org.apache.maven.settings.Mirror;
24  
25  /**
26   * Handles the selection of mirrors for repositories.
27   *
28   * @author Benjamin Bentmann
29   */
30  public interface MirrorSelector {
31  
32      /**
33       * Determines the mirror for the specified repository.
34       *
35       * @param repository The repository to determine the mirror for, must not be {@code null}.
36       * @param mirrors The available mirrors, may be {@code null}.
37       * @return The mirror specification for the repository or {@code null} if no mirror matched.
38       */
39      Mirror getMirror(ArtifactRepository repository, List<Mirror> mirrors);
40  }