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