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 org.eclipse.aether.RepositorySystem;
22 import org.eclipse.aether.RepositorySystemSession;
23 import org.eclipse.aether.resolution.ArtifactDescriptorException;
24 import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
25 import org.eclipse.aether.resolution.ArtifactDescriptorResult;
26
27 /**
28 * Provides information about an artifact that is relevant to transitive dependency resolution.
29 * Each artifact is expected to have an accompanying <em>artifact descriptor</em> that among others lists
30 * the direct dependencies of the artifact.
31 *
32 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
33 */
34 public interface ArtifactDescriptorReader {
35 /**
36 * Gets information about an artifact like its direct dependencies and potential relocations. Implementations must
37 * respect the {@link RepositorySystemSession#getArtifactDescriptorPolicy() artifact descriptor policy} of the
38 * session when dealing with certain error cases.
39 *
40 * @param session The repository session, must not be {@code null}.
41 * @param request The descriptor request, must not be {@code null}
42 * @return The descriptor result, never {@code null}.
43 * @throws ArtifactDescriptorException If the artifact descriptor could not be read.
44 * @see RepositorySystem#readArtifactDescriptor(RepositorySystemSession, ArtifactDescriptorRequest)
45 */
46 ArtifactDescriptorResult readArtifactDescriptor(RepositorySystemSession session, ArtifactDescriptorRequest request)
47 throws ArtifactDescriptorException;
48 }