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 import org.eclipse.aether.repository.RemoteRepository;
24
25 /**
26 * Composes path prefixes for {@link EnhancedLocalRepositoryManager}.
27 *
28 * @since 1.8.1
29 */
30 public interface LocalPathPrefixComposer {
31 /**
32 * Gets the path prefix for a locally installed artifact.
33 *
34 * @param artifact The artifact for which to determine the prefix, must not be {@code null}.
35 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
36 */
37 String getPathPrefixForLocalArtifact(Artifact artifact);
38
39 /**
40 * Gets the path prefix for an artifact cached from a remote repository.
41 *
42 * @param artifact The artifact for which to determine the prefix, must not be {@code null}.
43 * @param repository The remote repository, never {@code null}.
44 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
45 */
46 String getPathPrefixForRemoteArtifact(Artifact artifact, RemoteRepository repository);
47
48 /**
49 * Gets the path prefix for locally installed metadata.
50 *
51 * @param metadata The metadata for which to determine the prefix, must not be {@code null}.
52 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
53 */
54 String getPathPrefixForLocalMetadata(Metadata metadata);
55
56 /**
57 * Gets the path prefix for metadata cached from a remote repository.
58 *
59 * @param metadata The metadata for which to determine the prefix, must not be {@code null}.
60 * @param repository The remote repository, never {@code null}.
61 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
62 */
63 String getPathPrefixForRemoteMetadata(Metadata metadata, RemoteRepository repository);
64 }