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.internal.impl;
20
21 import org.eclipse.aether.artifact.Artifact;
22 import org.eclipse.aether.metadata.Metadata;
23
24 /**
25 * Composes {@link Artifact} and {@link Metadata} relative paths to be used in
26 * {@link org.eclipse.aether.repository.LocalRepositoryManager}.
27 *
28 * @since 1.8.1
29 */
30 public interface LocalPathComposer {
31 /**
32 * Gets the relative path for a locally installed (local=true) or remotely cached (local=false) artifact.
33 *
34 * @param artifact The artifact for which to determine the path, must not be {@code null}.
35 * @param local {@code true} if artifact is locally installed or {@code false} if artifact is remotely cached.
36 * @return A relative path representing artifact path.
37 */
38 String getPathForArtifact(Artifact artifact, boolean local);
39
40 /**
41 * Gets the relative path for locally installed (repositoryKey=local) or remotely cached metadata. The
42 * {@code repositoryKey} should be used at caller discretion, it merely denotes the origin of the metadata, while
43 * value "local" usually means local origin, but again, this is not a must or enforced, just how things happened
44 * so far.
45 *
46 * @param metadata The metadata for which to determine the path, must not be {@code null}.
47 * @param repositoryKey The repository key, never {@code null}.
48 * @return A relative path representing metadata path.
49 */
50 String getPathForMetadata(Metadata metadata, String repositoryKey);
51 }