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