001package org.eclipse.aether.internal.impl;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.eclipse.aether.artifact.Artifact;
023import org.eclipse.aether.metadata.Metadata;
024
025/**
026 * Composes {@link Artifact} and {@link Metadata} relative paths to be used in
027 * {@link org.eclipse.aether.repository.LocalRepositoryManager}.
028 *
029 * @since 1.8.1
030 */
031public interface LocalPathComposer
032{
033    /**
034     * Gets the relative path for a locally installed (local=true) or remotely cached (local=false) artifact.
035     *
036     * @param artifact The artifact for which to determine the path, must not be {@code null}.
037     * @param local    {@code true} if artifact is locally installed or {@code false} if artifact is remotely cached.
038     * @return A relative path representing artifact path.
039     */
040    String getPathForArtifact( Artifact artifact, boolean local );
041
042    /**
043     * Gets the relative path for locally installed (repositoryKey=local) or remotely cached metadata. The
044     * {@code repositoryKey} should be used at caller discretion, it merely denotes the origin of the metadata, while
045     * value "local" usually means local origin, but again, this is not a must or enforced, just how things happened
046     * so far.
047     *
048     * @param metadata      The metadata for which to determine the path, must not be {@code null}.
049     * @param repositoryKey The repository key, never {@code null}.
050     * @return A relative path representing metadata path.
051     */
052    String getPathForMetadata( Metadata metadata, String repositoryKey );
053}