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.Collection;
023import java.util.List;
024
025import org.eclipse.aether.RepositorySystem;
026import org.eclipse.aether.RepositorySystemSession;
027import org.eclipse.aether.metadata.Metadata;
028import org.eclipse.aether.resolution.MetadataRequest;
029import org.eclipse.aether.resolution.MetadataResult;
030
031/**
032 * Resolves metadata, that is gets a local filesystem path to their binary contents.
033 * 
034 * @noimplement This interface is not intended to be implemented by clients.
035 * @noextend This interface is not intended to be extended by clients.
036 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
037 */
038public interface MetadataResolver
039{
040
041    /**
042     * Resolves the paths for a collection of metadata. Metadata will be downloaded to the local repository if
043     * necessary, e.g. because it hasn't been cached yet or the cache is deemed outdated.
044     * 
045     * @param session The repository session, must not be {@code null}.
046     * @param requests The resolution requests, must not be {@code null}.
047     * @return The resolution results (in request order), never {@code null}.
048     * @see Metadata#getFile()
049     * @see RepositorySystem#resolveMetadata(RepositorySystemSession, Collection)
050     */
051    List<MetadataResult> resolveMetadata( RepositorySystemSession session,
052                                          Collection<? extends MetadataRequest> requests );
053
054}