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 org.eclipse.aether.RepositorySystem;
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.resolution.ArtifactDescriptorException;
024import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
025import org.eclipse.aether.resolution.ArtifactDescriptorResult;
026
027/**
028 * Provides information about an artifact that is relevant to transitive dependency resolution.
029 * Each artifact is expected to have an accompanying <em>artifact descriptor</em> that among others lists
030 * the direct dependencies of the artifact.
031 *
032 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
033 */
034public interface ArtifactDescriptorReader {
035    /**
036     * Gets information about an artifact like its direct dependencies and potential relocations. Implementations must
037     * respect the {@link RepositorySystemSession#getArtifactDescriptorPolicy() artifact descriptor policy} of the
038     * session when dealing with certain error cases.
039     *
040     * @param session The repository session, must not be {@code null}.
041     * @param request The descriptor request, must not be {@code null}
042     * @return The descriptor result, never {@code null}.
043     * @throws ArtifactDescriptorException If the artifact descriptor could not be read.
044     * @see RepositorySystem#readArtifactDescriptor(RepositorySystemSession, ArtifactDescriptorRequest)
045     */
046    ArtifactDescriptorResult readArtifactDescriptor(RepositorySystemSession session, ArtifactDescriptorRequest request)
047            throws ArtifactDescriptorException;
048}