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

Class GroupIdRemoteRepositoryFilterSource

java.lang.Object

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

org.eclipse.aether.internal.impl.filter.GroupIdRemoteRepositoryFilterSource

All Implemented Interfaces:

RemoteRepositoryFilterSource, ArtifactResolverPostProcessor

@Singleton
@Named("groupId")
public final class GroupIdRemoteRepositoryFilterSource
extends RemoteRepositoryFilterSourceSupport
implements ArtifactResolverPostProcessor

Remote repository filter source filtering on G coordinate. It is backed by a file that is parsed into GroupTree.

The file can be authored manually. The file can also be pre-populated by "record" functionality of this filter. When "recording", this filter will not filter out anything, but will instead populate the file with all encountered groupIds recorded as =groupId. The recorded file should be authored afterward to fine tune it, as there is no optimization in place (ie to look for smallest common parent groupId and alike).

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

The groupId file once loaded are cached in component, so in-flight groupId file change during component existence are NOT noticed.

Since:

1.9.0

See Also:

• GroupTree

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 GroupId filter (enabled by default).
static final String	CONFIG_PROP_NO_INPUT_OUTCOME	Determines what happens when the filter is enabled, but has no groupId file available for given remote repository to work with.
static final String	CONFIG_PROP_RECORD	Should filter go into "record" mode (and collect encountered artifacts)?
static final String	CONFIG_PROP_SKIPPED	Configuration to skip the GroupId filter for given request.
static final boolean	DEFAULT_ENABLED
static final boolean	DEFAULT_NO_INPUT_OUTCOME
static final boolean	DEFAULT_SKIPPED
static final String	LOCAL_REPO_PREFIX_DIR
static final String	NAME

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

CONFIG_PROP_REPOSITORY_KEY_FUNCTION, CONFIG_PROPS_PREFIX, DEFAULT_REPOSITORY_KEY_FUNCTION

Constructor Summary

Constructors

Constructor	Description
GroupIdRemoteRepositoryFilterSource(RepositoryKeyFunctionFactory repositoryKeyFunctionFactory, RepositorySystemLifecycle repositorySystemLifecycle, PathProcessor pathProcessor)

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.
void	postProcess(RepositorySystemSession session, List<ArtifactResult> artifactResults)	Receives resolver results just before it would return it to caller.

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

getBasedir, normalizeRemoteRepository, repositoryKey

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

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

• Location: Directory specified by CONFIG_PROP_BASEDIR (defaults to $LOCAL_REPO/.remoteRepositoryFilters)
• Naming: groupId-$(repository.id).txt
• Content: One groupId per line to allow/block from the repository

Recommended Setup (Per-Project): Use project-specific configuration to avoid repository ID clashes. Add to .mvn/maven.config:

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

Then create groupId-myrepoId.txt files in the .mvn/rrf/ directory and commit them to version control.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

DEFAULT_ENABLED

Supports Repo ID Suffix:

Yes

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

• Constant Field Values

CONFIG_PROP_SKIPPED

public static final String CONFIG_PROP_SKIPPED

Configuration to skip the GroupId filter for given request. This configuration is evaluated and if true the GroupId remote filter will not kick in.

Since:

2.0.14

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

DEFAULT_SKIPPED

Supports Repo ID Suffix:

Yes

DEFAULT_SKIPPED

public static final boolean DEFAULT_SKIPPED

See Also:

• Constant Field Values

CONFIG_PROP_NO_INPUT_OUTCOME

public static final String CONFIG_PROP_NO_INPUT_OUTCOME

Determines what happens when the filter is enabled, but has no groupId file available for given remote repository to work with. When set to true (default), the filter allows all requests to proceed for given remote repository when no groupId file is available. When set to false, the filter blocks all requests toward given remote repository when no groupId file is available. This setting allows repoId suffix, hence, can determine "global" or "repository targeted" behaviors.

Since:

2.0.14

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

DEFAULT_NO_INPUT_OUTCOME

Supports Repo ID Suffix:

Yes

DEFAULT_NO_INPUT_OUTCOME

public static final boolean DEFAULT_NO_INPUT_OUTCOME

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

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

CONFIG_PROP_RECORD

public static final String CONFIG_PROP_RECORD

Should filter go into "record" mode (and collect encountered artifacts)?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

Constructor Details

GroupIdRemoteRepositoryFilterSource

@Inject
public GroupIdRemoteRepositoryFilterSource(RepositoryKeyFunctionFactory repositoryKeyFunctionFactory,
 RepositorySystemLifecycle repositorySystemLifecycle,
 PathProcessor pathProcessor)

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 true.

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.

Specified by:

getRemoteRepositoryFilter in interface RemoteRepositoryFilterSource

Returns:

The filter for given session or null.

postProcess

public void postProcess(RepositorySystemSession session,
 List<ArtifactResult> artifactResults)

Description copied from interface: ArtifactResolverPostProcessor

Receives resolver results just before it would return it to caller. Is able to generate "resolution failure" by augmenting passed in ArtifactResults (artifacts should be "unresolved" and exceptions added).

Implementations must be aware that the passed in list of ArtifactResults may have failed resolutions, best to check that using ArtifactResult.isResolved() method.

The implementations must be aware that this call may be "hot", so it directly affects the performance of resolver in general.

Specified by:

postProcess in interface ArtifactResolverPostProcessor