Class PrefixesRemoteRepositoryFilterSource

java.lang.Object

org.eclipse.aether.internal.impl.filter.RemoteRepositoryFilterSourceSupport

org.eclipse.aether.internal.impl.filter.PrefixesRemoteRepositoryFilterSource

All Implemented Interfaces:

org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilterSource

@Singleton
@Named("prefixes")
public final class PrefixesRemoteRepositoryFilterSource
extends RemoteRepositoryFilterSourceSupport

Remote repository filter source filtering on path prefixes. It is backed by a file that lists all allowed path prefixes from remote repository. Artifact that layout converted path (using remote repository layout) results in path with no corresponding prefix present in this file is filtered out.

The file can be authored manually: format is one prefix per line, comments starting with "#" (hash) and empty lines for structuring are supported, The "/" (slash) character is used as file separator. Some remote repositories and MRMs publish these kind of files, they can be downloaded from corresponding URLs.

The prefix file is expected on path "${basedir}/prefixes-${repository.id}.txt".

The prefixes file is once loaded and cached, so in-flight prefixes file change during component existence are not noticed.

Examples of published prefix files:

• Central: prefixes.txt
• Apache Releases: prefixes.txt

Since:

1.9.0

Nested Class Summary

Nested classes/interfaces inherited from class RemoteRepositoryFilterSourceSupport

RemoteRepositoryFilterSourceSupport.SimpleResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_BASEDIR	The basedir where to store filter files.
static final String	CONFIG_PROP_ENABLED	Configuration to enable the Prefixes filter (enabled by default).
static final boolean	DEFAULT_ENABLED
static final String	LOCAL_REPO_PREFIX_DIR
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
PrefixesRemoteRepositoryFilterSource(Supplier<MetadataResolver> metadataResolver, Supplier<RemoteRepositoryManager> remoteRepositoryManager, org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider repositoryLayoutProvider)

Method Summary

Modifier and Type	Method	Description
org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilter	getRemoteRepositoryFilter(org.eclipse.aether.RepositorySystemSession session)
protected boolean	isEnabled(org.eclipse.aether.RepositorySystemSession session)	Returns true if session configuration contains this name set to true.

Methods inherited from class RemoteRepositoryFilterSourceSupport

getBasedir

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CONFIG_PROP_ENABLED

public static final String CONFIG_PROP_ENABLED

Configuration to enable the Prefixes filter (enabled by default). Can be fine-tuned per repository using repository ID suffixes. Important: For this filter to take effect, configuration files must be available. Without configuration files, the enabled filter remains dormant and does not interfere with resolution. Configuration File Resolution:

1. User-provided files: Checked first from directory specified by CONFIG_PROP_BASEDIR (defaults to $LOCAL_REPO/.remoteRepositoryFilters)
2. Auto-discovery: If not found, attempts to download from remote repository and cache locally

File Naming: prefixes-$(repository.id).txt Recommended Setup (Auto-Discovery with Override Capability): Start with auto-discovery, but prepare for project-specific overrides. Add to .mvn/maven.config:

-Daether.remoteRepositoryFilter.prefixes=true
-Daether.remoteRepositoryFilter.prefixes.basedir=${session.rootDirectory}/.mvn/rrf/

Initial setup: Don't provide any files - rely on auto-discovery as repositories are accessed. Override when needed: Create prefixes-myrepoId.txt files in .mvn/rrf/ and commit to version control. Caching: Auto-discovered prefix files are cached in the local repository with unique IDs (using RepositoryIdHelper.remoteRepositoryUniqueId(RemoteRepository)) to prevent conflicts that could cause build failures.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

• Constant Field Values

CONFIG_PROP_BASEDIR

public static final String CONFIG_PROP_BASEDIR

The basedir where to store filter files. If path is relative, it is resolved from local repository root.

See Also:

• Constant Field Values

LOCAL_REPO_PREFIX_DIR

public static final String LOCAL_REPO_PREFIX_DIR

See Also:

• Constant Field Values

Constructor Details

PrefixesRemoteRepositoryFilterSource

@Inject
public PrefixesRemoteRepositoryFilterSource(Supplier<MetadataResolver> metadataResolver,
 Supplier<RemoteRepositoryManager> remoteRepositoryManager,
 org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider repositoryLayoutProvider)

Method Details

isEnabled

protected boolean isEnabled(org.eclipse.aether.RepositorySystemSession session)

Description copied from class: RemoteRepositoryFilterSourceSupport

Returns true if session configuration contains this name set to true.

Default is true.

Specified by:

isEnabled in class RemoteRepositoryFilterSourceSupport

getRemoteRepositoryFilter

public org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilter getRemoteRepositoryFilter(org.eclipse.aether.RepositorySystemSession session)