001package org.eclipse.aether.impl;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 * 
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 * 
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.Collection;
023import java.util.List;
024
025import org.eclipse.aether.RepositorySystem;
026import org.eclipse.aether.RepositorySystemSession;
027import org.eclipse.aether.artifact.Artifact;
028import org.eclipse.aether.resolution.ArtifactRequest;
029import org.eclipse.aether.resolution.ArtifactResolutionException;
030import org.eclipse.aether.resolution.ArtifactResult;
031
032/**
033 * Resolves artifacts, that is gets a local filesystem path to their binary contents.
034 * 
035 * @noimplement This interface is not intended to be implemented by clients.
036 * @noextend This interface is not intended to be extended by clients.
037 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
038 */
039public interface ArtifactResolver
040{
041
042    /**
043     * Resolves the path for an artifact. The artifact will be downloaded to the local repository if necessary. An
044     * artifact that is already resolved will be skipped and is not re-resolved. Note that this method assumes that any
045     * relocations have already been processed and the artifact coordinates are used as-is.
046     * 
047     * @param session The repository session, must not be {@code null}.
048     * @param request The resolution request, must not be {@code null}.
049     * @return The resolution result, never {@code null}.
050     * @throws ArtifactResolutionException If the artifact could not be resolved.
051     * @see Artifact#getFile()
052     * @see RepositorySystem#resolveArtifact(RepositorySystemSession, ArtifactRequest)
053     */
054    ArtifactResult resolveArtifact( RepositorySystemSession session, ArtifactRequest request )
055        throws ArtifactResolutionException;
056
057    /**
058     * Resolves the paths for a collection of artifacts. Artifacts will be downloaded to the local repository if
059     * necessary. Artifacts that are already resolved will be skipped and are not re-resolved. Note that this method
060     * assumes that any relocations have already been processed and the artifact coordinates are used as-is.
061     * 
062     * @param session The repository session, must not be {@code null}.
063     * @param requests The resolution requests, must not be {@code null}.
064     * @return The resolution results (in request order), never {@code null}.
065     * @throws ArtifactResolutionException If any artifact could not be resolved.
066     * @see Artifact#getFile()
067     * @see RepositorySystem#resolveArtifacts(RepositorySystemSession, Collection)
068     */
069    List<ArtifactResult> resolveArtifacts( RepositorySystemSession session,
070                                           Collection<? extends ArtifactRequest> requests )
071        throws ArtifactResolutionException;
072
073}