Class ChainedLocalRepositoryManager
- java.lang.Object
-
- org.eclipse.aether.util.repository.ChainedLocalRepositoryManager
-
- All Implemented Interfaces:
LocalRepositoryManager
public final class ChainedLocalRepositoryManager extends java.lang.Object implements LocalRepositoryManager
A local repository manager that chains multiple local repository managers: it directs all the write operations to chain head, while uses tail forfind(RepositorySystemSession, LocalArtifactRequest)
andfind(RepositorySystemSession, LocalMetadataRequest)
methods only. Hence, tail is used in resolving metadata and artifacts with or without (configurable) artifact availability tracking.Implementation represents itself using the head local repository manager.
- Since:
- 1.9.2
-
-
Field Summary
Fields Modifier and Type Field Description private LocalRepositoryManager
head
private boolean
ignoreTailAvailability
private java.util.List<LocalRepositoryManager>
tail
-
Constructor Summary
Constructors Constructor Description ChainedLocalRepositoryManager(LocalRepositoryManager head, java.util.List<LocalRepositoryManager> tail, boolean ignoreTailAvailability)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(RepositorySystemSession session, LocalArtifactRegistration request)
Registers an installed or resolved artifact with the local repository.void
add(RepositorySystemSession session, LocalMetadataRegistration request)
Registers installed or resolved metadata with the local repository.LocalArtifactResult
find(RepositorySystemSession session, LocalArtifactRequest request)
Queries for the existence of an artifact in the local repository.LocalMetadataResult
find(RepositorySystemSession session, LocalMetadataRequest request)
Queries for the existence of metadata in the local repository.java.lang.String
getPathForLocalArtifact(Artifact artifact)
Gets the relative path for a locally installed artifact.java.lang.String
getPathForLocalMetadata(Metadata metadata)
Gets the relative path for locally installed metadata.java.lang.String
getPathForRemoteArtifact(Artifact artifact, RemoteRepository repository, java.lang.String context)
Gets the relative path for an artifact cached from a remote repository.java.lang.String
getPathForRemoteMetadata(Metadata metadata, RemoteRepository repository, java.lang.String context)
Gets the relative path for metadata cached from a remote repository.LocalRepository
getRepository()
Gets the description of the local repository being managed.java.lang.String
toString()
-
-
-
Field Detail
-
head
private final LocalRepositoryManager head
-
tail
private final java.util.List<LocalRepositoryManager> tail
-
ignoreTailAvailability
private final boolean ignoreTailAvailability
-
-
Constructor Detail
-
ChainedLocalRepositoryManager
public ChainedLocalRepositoryManager(LocalRepositoryManager head, java.util.List<LocalRepositoryManager> tail, boolean ignoreTailAvailability)
-
-
Method Detail
-
getRepository
public LocalRepository getRepository()
Description copied from interface:LocalRepositoryManager
Gets the description of the local repository being managed.- Specified by:
getRepository
in interfaceLocalRepositoryManager
- Returns:
- The description of the local repository, never
null
.
-
getPathForLocalArtifact
public java.lang.String getPathForLocalArtifact(Artifact artifact)
Description copied from interface:LocalRepositoryManager
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. The path uses the forward slash as directory separator regardless of the underlying file system.- Specified by:
getPathForLocalArtifact
in interfaceLocalRepositoryManager
- Parameters:
artifact
- The artifact for which to determine the path, must not benull
.- Returns:
- The path, relative to the local repository's base directory.
-
getPathForRemoteArtifact
public java.lang.String getPathForRemoteArtifact(Artifact artifact, RemoteRepository repository, java.lang.String context)
Description copied from interface:LocalRepositoryManager
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. The path uses the forward slash as directory separator regardless of the underlying file system.- Specified by:
getPathForRemoteArtifact
in interfaceLocalRepositoryManager
- Parameters:
artifact
- The artifact for which to determine the path, must not benull
.repository
- The source repository of the artifact, must not benull
.context
- The resolution context in which the artifact is being requested, may benull
.- Returns:
- The path, relative to the local repository's base directory.
-
getPathForLocalMetadata
public java.lang.String getPathForLocalMetadata(Metadata metadata)
Description copied from interface:LocalRepositoryManager
Gets the relative path for locally installed metadata. Note that the metadata need not actually exist yet at the returned location, the path merely indicates where the metadata would eventually be stored. The path uses the forward slash as directory separator regardless of the underlying file system.- Specified by:
getPathForLocalMetadata
in interfaceLocalRepositoryManager
- Parameters:
metadata
- The metadata for which to determine the path, must not benull
.- Returns:
- The path, relative to the local repository's base directory.
-
getPathForRemoteMetadata
public java.lang.String getPathForRemoteMetadata(Metadata metadata, RemoteRepository repository, java.lang.String context)
Description copied from interface:LocalRepositoryManager
Gets the relative path for metadata cached from a remote repository. Note that the metadata need not actually exist yet at the returned location, the path merely indicates where the metadata would eventually be stored. The path uses the forward slash as directory separator regardless of the underlying file system.- Specified by:
getPathForRemoteMetadata
in interfaceLocalRepositoryManager
- Parameters:
metadata
- The metadata for which to determine the path, must not benull
.repository
- The source repository of the metadata, must not benull
.context
- The resolution context in which the metadata is being requested, may benull
.- Returns:
- The path, relative to the local repository's base directory.
-
find
public LocalArtifactResult find(RepositorySystemSession session, LocalArtifactRequest request)
Description copied from interface:LocalRepositoryManager
Queries for the existence of an artifact in the local repository. The request could be satisfied by a locally installed artifact or a previously downloaded artifact.- Specified by:
find
in interfaceLocalRepositoryManager
- Parameters:
session
- The repository system session during which the request is made, must not benull
.request
- The artifact request, must not benull
.- Returns:
- The result of the request, never
null
.
-
add
public void add(RepositorySystemSession session, LocalArtifactRegistration request)
Description copied from interface:LocalRepositoryManager
Registers an installed or resolved artifact with the local repository. Note that artifact registration is merely concerned about updating the local repository's internal state, not about actually installing the artifact or its accompanying metadata.- Specified by:
add
in interfaceLocalRepositoryManager
- Parameters:
session
- The repository system session during which the registration is made, must not benull
.request
- The registration request, must not benull
.
-
find
public LocalMetadataResult find(RepositorySystemSession session, LocalMetadataRequest request)
Description copied from interface:LocalRepositoryManager
Queries for the existence of metadata in the local repository. The request could be satisfied by locally installed or previously downloaded metadata.- Specified by:
find
in interfaceLocalRepositoryManager
- Parameters:
session
- The repository system session during which the request is made, must not benull
.request
- The metadata request, must not benull
.- Returns:
- The result of the request, never
null
.
-
add
public void add(RepositorySystemSession session, LocalMetadataRegistration request)
Description copied from interface:LocalRepositoryManager
Registers installed or resolved metadata with the local repository. Note that metadata registration is merely concerned about updating the local repository's internal state, not about actually installing the metadata. However, this method MUST be called after the actual install to give the repository manager the opportunity to inspect the added metadata.- Specified by:
add
in interfaceLocalRepositoryManager
- Parameters:
session
- The repository system session during which the registration is made, must not benull
.request
- The registration request, must not benull
.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-