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