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 lists all allowed groupIds and groupId not present in this file are filtered out.

The file can be authored manually: format is one groupId per line, comments starting with "#" (hash) amd empty lines for structuring are supported. 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.

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

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	CONFIG_PROP_RECORD	Should filter go into "record" mode (and collect encountered artifacts)?
static final String	LOCAL_REPO_PREFIX_DIR
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
GroupIdRemoteRepositoryFilterSource(RepositorySystemLifecycle repositorySystemLifecycle)

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

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

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(RepositorySystemLifecycle repositorySystemLifecycle)

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.

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