001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.internal.impl;
020
021import org.eclipse.aether.artifact.Artifact;
022import org.eclipse.aether.metadata.Metadata;
023import org.eclipse.aether.repository.RemoteRepository;
024
025/**
026 * Composes path prefixes for {@link EnhancedLocalRepositoryManager}.
027 *
028 * @since 1.8.1
029 */
030public interface LocalPathPrefixComposer {
031    /**
032     * Gets the path prefix for a locally installed artifact.
033     *
034     * @param artifact The artifact for which to determine the prefix, must not be {@code null}.
035     * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
036     */
037    String getPathPrefixForLocalArtifact(Artifact artifact);
038
039    /**
040     * Gets the path prefix for an artifact cached from a remote repository.
041     *
042     * @param artifact      The artifact for which to determine the prefix, must not be {@code null}.
043     * @param repository    The remote repository, never {@code null}.
044     * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
045     */
046    String getPathPrefixForRemoteArtifact(Artifact artifact, RemoteRepository repository);
047
048    /**
049     * Gets the path prefix for locally installed metadata.
050     *
051     * @param metadata The metadata for which to determine the prefix, must not be {@code null}.
052     * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
053     */
054    String getPathPrefixForLocalMetadata(Metadata metadata);
055
056    /**
057     * Gets the path prefix for metadata cached from a remote repository.
058     *
059     * @param metadata      The metadata for which to determine the prefix, must not be {@code null}.
060     * @param repository    The remote repository, never {@code null}.
061     * @return The prefix, may be {@code null} (note: {@code null}s and empty strings are treated equally).
062     */
063    String getPathPrefixForRemoteMetadata(Metadata metadata, RemoteRepository repository);
064}