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.collection.CollectRequest;
024import org.eclipse.aether.collection.CollectResult;
025import org.eclipse.aether.collection.DependencyCollectionException;
026
027/**
028 * Given a collection of direct dependencies, recursively gathers their transitive dependencies and calculates the
029 * dependency graph.
030 *
031 * @noimplement This interface is not intended to be implemented by clients.
032 * @noextend This interface is not intended to be extended by clients.
033 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
034 */
035public interface DependencyCollector {
036
037    /**
038     * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
039     * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
040     * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
041     * throughout the operation.
042     *
043     * @param session The repository session, must not be {@code null}.
044     * @param request The collection request, must not be {@code null}.
045     * @return The collection result, never {@code null}.
046     * @throws DependencyCollectionException If the dependency tree could not be built.
047     * @see RepositorySystemSession#getDependencyTraverser()
048     * @see RepositorySystemSession#getDependencyManager()
049     * @see RepositorySystemSession#getDependencySelector()
050     * @see RepositorySystemSession#getVersionFilter()
051     * @see RepositorySystemSession#getDependencyGraphTransformer()
052     * @see RepositorySystem#collectDependencies(RepositorySystemSession, CollectRequest)
053     */
054    CollectResult collectDependencies(RepositorySystemSession session, CollectRequest request)
055            throws DependencyCollectionException;
056}