1 package org.eclipse.aether.impl;
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.Collection;
23 import java.util.List;
24
25 import org.eclipse.aether.RepositorySystem;
26 import org.eclipse.aether.RepositorySystemSession;
27 import org.eclipse.aether.metadata.Metadata;
28 import org.eclipse.aether.resolution.MetadataRequest;
29 import org.eclipse.aether.resolution.MetadataResult;
30
31 /**
32 * Resolves metadata, that is gets a local filesystem path to their binary contents.
33 *
34 * @noimplement This interface is not intended to be implemented by clients.
35 * @noextend This interface is not intended to be extended by clients.
36 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
37 */
38 public interface MetadataResolver
39 {
40
41 /**
42 * Resolves the paths for a collection of metadata. Metadata will be downloaded to the local repository if
43 * necessary, e.g. because it hasn't been cached yet or the cache is deemed outdated.
44 *
45 * @param session The repository session, must not be {@code null}.
46 * @param requests The resolution requests, must not be {@code null}.
47 * @return The resolution results (in request order), never {@code null}.
48 * @see Metadata#getFile()
49 * @see RepositorySystem#resolveMetadata(RepositorySystemSession, Collection)
50 */
51 List<MetadataResult> resolveMetadata( RepositorySystemSession session,
52 Collection<? extends MetadataRequest> requests );
53
54 }