View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.impl;
20  
21  import java.util.Collection;
22  import java.util.List;
23  
24  import org.eclipse.aether.RepositorySystem;
25  import org.eclipse.aether.RepositorySystemSession;
26  import org.eclipse.aether.metadata.Metadata;
27  import org.eclipse.aether.resolution.MetadataRequest;
28  import org.eclipse.aether.resolution.MetadataResult;
29  
30  /**
31   * Resolves metadata, that is gets a local filesystem path to their binary contents.
32   *
33   * @noimplement This interface is not intended to be implemented by clients.
34   * @noextend This interface is not intended to be extended by clients.
35   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
36   */
37  public interface MetadataResolver {
38  
39      /**
40       * Resolves the paths for a collection of metadata. Metadata will be downloaded to the local repository if
41       * necessary, e.g. because it hasn't been cached yet or the cache is deemed outdated.
42       *
43       * @param session The repository session, must not be {@code null}.
44       * @param requests The resolution requests, must not be {@code null}.
45       * @return The resolution results (in request order), never {@code null}.
46       * @see Metadata#getFile()
47       * @see RepositorySystem#resolveMetadata(RepositorySystemSession, Collection)
48       */
49      List<MetadataResult> resolveMetadata(
50              RepositorySystemSession session, Collection<? extends MetadataRequest> requests);
51  }