001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.impl;
020
021import java.util.Collection;
022import java.util.List;
023
024import org.eclipse.aether.RepositorySystem;
025import org.eclipse.aether.RepositorySystemSession;
026import org.eclipse.aether.metadata.Metadata;
027import org.eclipse.aether.resolution.MetadataRequest;
028import org.eclipse.aether.resolution.MetadataResult;
029
030/**
031 * Resolves metadata, that is gets a local filesystem path to their binary contents.
032 *
033 * @noimplement This interface is not intended to be implemented by clients.
034 * @noextend This interface is not intended to be extended by clients.
035 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
036 */
037public interface MetadataResolver {
038
039    /**
040     * Resolves the paths for a collection of metadata. Metadata will be downloaded to the local repository if
041     * necessary, e.g. because it hasn't been cached yet or the cache is deemed outdated.
042     *
043     * @param session The repository session, must not be {@code null}.
044     * @param requests The resolution requests, must not be {@code null}.
045     * @return The resolution results (in request order), never {@code null}.
046     * @see Metadata#getFile()
047     * @see RepositorySystem#resolveMetadata(RepositorySystemSession, Collection)
048     */
049    List<MetadataResult> resolveMetadata(
050            RepositorySystemSession session, Collection<? extends MetadataRequest> requests);
051}