1 package org.eclipse.aether.internal.impl;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.eclipse.aether.artifact.Artifact;
23 import org.eclipse.aether.metadata.Metadata;
24 import org.eclipse.aether.repository.RemoteRepository;
25
26 /**
27 * Composes path prefixes for {@link EnhancedLocalRepositoryManager}.
28 *
29 * @since 1.8.1
30 */
31 public interface LocalPathPrefixComposer
32 {
33 /**
34 * Gets the path prefix for a locally installed artifact.
35 *
36 * @param artifact The artifact for which to determine the prefix, must not be {@code null}.
37 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
38 */
39 String getPathPrefixForLocalArtifact( Artifact artifact );
40
41 /**
42 * Gets the path prefix for an artifact cached from a remote repository.
43 *
44 * @param artifact The artifact for which to determine the prefix, must not be {@code null}.
45 * @param repository The remote repository, never {@code null}.
46 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
47 */
48 String getPathPrefixForRemoteArtifact( Artifact artifact, RemoteRepository repository );
49
50 /**
51 * Gets the path prefix for locally installed metadata.
52 *
53 * @param metadata The metadata for which to determine the prefix, must not be {@code null}.
54 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
55 */
56 String getPathPrefixForLocalMetadata( Metadata metadata );
57
58 /**
59 * Gets the path prefix for metadata cached from a remote repository.
60 *
61 * @param metadata The metadata for which to determine the prefix, must not be {@code null}.
62 * @param repository The remote repository, never {@code null}.
63 * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
64 */
65 String getPathPrefixForRemoteMetadata( Metadata metadata, RemoteRepository repository );
66 }