1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.repository;
20
21 import java.io.File;
22 import java.nio.file.Path;
23 import java.util.List;
24
25 import org.eclipse.aether.artifact.Artifact;
26
27 /**
28 * Manages a repository backed by the IDE workspace, a build session or a similar ad-hoc collection of artifacts.
29 *
30 * @see org.eclipse.aether.RepositorySystemSession#getWorkspaceReader()
31 */
32 public interface WorkspaceReader {
33
34 /**
35 * Gets a description of the workspace repository.
36 *
37 * @return The repository description, never {@code null}.
38 */
39 WorkspaceRepository getRepository();
40
41 /**
42 * Locates the specified artifact.
43 *
44 * @param artifact The artifact to locate, must not be {@code null}.
45 * @return The path to the artifact or {@code null} if the artifact is not available.
46 */
47 File findArtifact(Artifact artifact);
48
49 /**
50 * Locates the specified artifact.
51 *
52 * @param artifact The artifact to locate, must not be {@code null}.
53 * @return The path to the artifact or {@code null} if the artifact is not available.
54 * @since 2.0.0
55 */
56 default Path findArtifactPath(Artifact artifact) {
57 File file = findArtifact(artifact);
58 return file != null ? file.toPath() : null;
59 }
60
61 /**
62 * Determines all available versions of the specified artifact.
63 *
64 * @param artifact The artifact whose versions should be listed, must not be {@code null}.
65 * @return The available versions of the artifact, must not be {@code null}.
66 */
67 List<String> findVersions(Artifact artifact);
68 }