001package org.apache.maven.repository;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.List;
023
024import org.apache.maven.artifact.repository.ArtifactRepository;
025import org.apache.maven.settings.Mirror;
026
027/**
028 * Handles the selection of mirrors for repositories.
029 *
030 * @author Benjamin Bentmann
031 */
032public interface MirrorSelector
033{
034
035    /**
036     * Determines the mirror for the specified repository.
037     *
038     * @param repository The repository to determine the mirror for, must not be {@code null}.
039     * @param mirrors The available mirrors, may be {@code null}.
040     * @return The mirror specification for the repository or {@code null} if no mirror matched.
041     */
042    Mirror getMirror( ArtifactRepository repository, List<Mirror> mirrors );
043
044}