Package org.apache.maven.api.services

Interface LocalRepositoryManager

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultLocalRepositoryManager

@Experimental
public interface LocalRepositoryManager
extends Service

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
Path	getPathForLocalArtifact(Session session, LocalRepository local, Artifact artifact)	Gets the relative path for a locally installed artifact.
Path	getPathForRemoteArtifact(Session session, LocalRepository local, RemoteRepository remote, Artifact artifact)	Gets the relative path for an artifact cached from a remote repository.

Method Details

getPathForLocalArtifact

@Nonnull
Path getPathForLocalArtifact(@Nonnull
 Session session,
 @Nonnull
 LocalRepository local,
 @Nonnull
 Artifact artifact)

Gets the relative path for a locally installed artifact. Note that the artifact need not actually exist yet at the returned location, the path merely indicates where the artifact would eventually be stored.

Parameters:

session - The session to use, must not be null.

artifact - The artifact for which to determine the path, must not be null.

Returns:

The path, resolved against the local repository's base directory.

getPathForRemoteArtifact

@Nonnull
Path getPathForRemoteArtifact(@Nonnull
 Session session,
 @Nonnull
 LocalRepository local,
 @Nonnull
 RemoteRepository remote,
 @Nonnull
 Artifact artifact)

Gets the relative path for an artifact cached from a remote repository. Note that the artifact need not actually exist yet at the returned location, the path merely indicates where the artifact would eventually be stored.

Parameters:

session - The session to use, must not be null.

local - The local repository, must not be null.

artifact - The artifact for which to determine the path, must not be null.

remote - – The source repository of the artifact, must not be null.

Returns:

The path, relative to the local repository's base directory.