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.repository;
020
021import java.io.File;
022import java.util.List;
023
024import org.eclipse.aether.artifact.Artifact;
025
026/**
027 * Manages a repository backed by the IDE workspace, a build session or a similar ad-hoc collection of artifacts.
028 *
029 * @see org.eclipse.aether.RepositorySystemSession#getWorkspaceReader()
030 */
031public interface WorkspaceReader {
032
033    /**
034     * Gets a description of the workspace repository.
035     *
036     * @return The repository description, never {@code null}.
037     */
038    WorkspaceRepository getRepository();
039
040    /**
041     * Locates the specified artifact.
042     *
043     * @param artifact The artifact to locate, must not be {@code null}.
044     * @return The path to the artifact or {@code null} if the artifact is not available.
045     */
046    File findArtifact(Artifact artifact);
047
048    /**
049     * Determines all available versions of the specified artifact.
050     *
051     * @param artifact The artifact whose versions should be listed, must not be {@code null}.
052     * @return The available versions of the artifact, must not be {@code null}.
053     */
054    List<String> findVersions(Artifact artifact);
055}