001package org.eclipse.aether.impl;
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.eclipse.aether.RepositorySystemSession;
025import org.eclipse.aether.repository.RemoteRepository;
026import org.eclipse.aether.repository.RepositoryPolicy;
027
028/**
029 * Helps dealing with remote repository definitions.
030 * 
031 * @noimplement This interface is not intended to be implemented by clients.
032 * @noextend This interface is not intended to be extended by clients.
033 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
034 */
035public interface RemoteRepositoryManager
036{
037
038    /**
039     * Aggregates repository definitions by merging duplicate repositories and optionally applies mirror, proxy and
040     * authentication settings from the supplied session.
041     * 
042     * @param session The repository session during which the repositories will be accessed, must not be {@code null}.
043     * @param dominantRepositories The current list of remote repositories to merge the new definitions into, must not
044     *            be {@code null}.
045     * @param recessiveRepositories The remote repositories to merge into the existing list, must not be {@code null}.
046     * @param recessiveIsRaw {@code true} if the recessive repository definitions have not yet been subjected to mirror,
047     *            proxy and authentication settings, {@code false} otherwise.
048     * @return The aggregated list of remote repositories, never {@code null}.
049     * @see RepositorySystemSession#getMirrorSelector()
050     * @see RepositorySystemSession#getProxySelector()
051     * @see RepositorySystemSession#getAuthenticationSelector()
052     */
053    List<RemoteRepository> aggregateRepositories( RepositorySystemSession session,
054                                                  List<RemoteRepository> dominantRepositories,
055                                                  List<RemoteRepository> recessiveRepositories,
056                                                  boolean recessiveIsRaw );
057
058    /**
059     * Gets the effective repository policy for the specified remote repository by merging the applicable
060     * snapshot/release policy of the repository with global settings from the supplied session.
061     * 
062     * @param session The repository session during which the repository will be accessed, must not be {@code null}.
063     * @param repository The remote repository to determine the effective policy for, must not be {@code null}.
064     * @param releases {@code true} if the policy for release artifacts needs to be considered, {@code false} if not.
065     * @param snapshots {@code true} if the policy for snapshot artifacts needs to be considered, {@code false} if not.
066     * @return The effective repository policy, never {@code null}.
067     * @see RepositorySystemSession#getChecksumPolicy()
068     * @see RepositorySystemSession#getUpdatePolicy()
069     */
070    RepositoryPolicy getPolicy( RepositorySystemSession session, RemoteRepository repository, boolean releases,
071                                boolean snapshots );
072
073}