Package org.eclipse.aether.internal.impl.filter

Class PrefixesRemoteRepositoryFilterSource

java.lang.Object

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

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

All Implemented Interfaces:

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 org.eclipse.aether.internal.impl.filter.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	Is filter enabled?
static final String	LOCAL_REPO_PREFIX_DIR
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
PrefixesRemoteRepositoryFilterSource(RepositoryLayoutProvider repositoryLayoutProvider)

Method Summary

Modifier and Type	Method	Description
RemoteRepositoryFilter	getRemoteRepositoryFilter(RepositorySystemSession session)	Provides the filter instance for given session, or null if this instance wants to abstain from participating in filtering.
protected boolean	isEnabled(RepositorySystemSession session)	Returns true if session configuration contains this name set to true.

Methods inherited from class org.eclipse.aether.internal.impl.filter.RemoteRepositoryFilterSourceSupport

getBasedir

Methods inherited from class java.lang.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

Is filter enabled?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

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

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

LOCAL_REPO_PREFIX_DIR

LOCAL_REPO_PREFIX_DIR

public static final String LOCAL_REPO_PREFIX_DIR

See Also:

• Constant Field Values

Constructor Details

PrefixesRemoteRepositoryFilterSource

@Inject
public PrefixesRemoteRepositoryFilterSource(RepositoryLayoutProvider repositoryLayoutProvider)

Method Details

isEnabled

protected boolean isEnabled(RepositorySystemSession session)

Description copied from class: RemoteRepositoryFilterSourceSupport

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

Default is false.

Specified by:

isEnabled in class RemoteRepositoryFilterSourceSupport

getRemoteRepositoryFilter

public RemoteRepositoryFilter getRemoteRepositoryFilter(RepositorySystemSession session)

Description copied from interface: RemoteRepositoryFilterSource

Provides the filter instance for given session, or null if this instance wants to abstain from participating in filtering.

Returns:

The filter for given session or null.