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

Modifier and Type	Class	Description
private class	GroupIdRemoteRepositoryFilterSource.GroupIdFilter

Nested classes/interfaces inherited from class org.eclipse.aether.internal.impl.filter.RemoteRepositoryFilterSourceSupport

RemoteRepositoryFilterSourceSupport.SimpleResult

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentHashMap<Path,Boolean>	changedRules
private static final String	CONF_NAME_RECORD
(package private) static final String	GROUP_ID_FILE_PREFIX
(package private) static final String	GROUP_ID_FILE_SUFFIX
private static final org.slf4j.Logger	LOGGER
static final String	NAME
private static final TreeSet<String>	NOT_PRESENT
private static final RemoteRepositoryFilter.Result	NOT_PRESENT_RESULT
private final AtomicBoolean	onShutdownHandlerRegistered
private final RepositorySystemLifecycle	repositorySystemLifecycle
private final ConcurrentHashMap<Path,Set<String>>	rules

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

LOCAL_REPO_PREFIX_DIR

Constructor Summary

Constructors

Constructor	Description
GroupIdRemoteRepositoryFilterSource(RepositorySystemLifecycle repositorySystemLifecycle)

Method Summary

Modifier and Type	Method	Description
private Set<String>	cacheRules(RepositorySystemSession session, RemoteRepository remoteRepository)
private Path	filePath(Path basedir, String remoteRepositoryId)	Returns the groupId path.
RemoteRepositoryFilter	getRemoteRepositoryFilter(RepositorySystemSession session)	Provides the filter instance for given session, or null if this instance wants to abstain from participating in filtering.
private boolean	isRecord(RepositorySystemSession session)	Returns true if given session is recording.
private Set<String>	loadRepositoryRules(Path filePath)
void	postProcess(RepositorySystemSession session, List<ArtifactResult> artifactResults)	Receives resolver results just before it would return it to caller.
private void	saveRecordedLines()	On-close handler that saves recorded rules, if any.

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

configPropKey, getBasedir, isEnabled

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

CONF_NAME_RECORD

private static final String CONF_NAME_RECORD

See Also:

• Constant Field Values

GROUP_ID_FILE_PREFIX

static final String GROUP_ID_FILE_PREFIX

See Also:

• Constant Field Values

GROUP_ID_FILE_SUFFIX

static final String GROUP_ID_FILE_SUFFIX

See Also:

• Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

repositorySystemLifecycle

private final RepositorySystemLifecycle repositorySystemLifecycle

rules

private final ConcurrentHashMap<Path,Set<String>> rules

changedRules

private final ConcurrentHashMap<Path,Boolean> changedRules

onShutdownHandlerRegistered

private final AtomicBoolean onShutdownHandlerRegistered

NOT_PRESENT

private static final TreeSet<String> NOT_PRESENT

NOT_PRESENT_RESULT

private static final RemoteRepositoryFilter.Result NOT_PRESENT_RESULT

Constructor Details

GroupIdRemoteRepositoryFilterSource

@Inject
public GroupIdRemoteRepositoryFilterSource(RepositorySystemLifecycle repositorySystemLifecycle)

Method Details

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

filePath

private Path filePath(Path basedir,
 String remoteRepositoryId)

Returns the groupId path. The file and parents may not exist, this method merely calculate the path.

cacheRules

private Set<String> cacheRules(RepositorySystemSession session,
 RemoteRepository remoteRepository)

loadRepositoryRules

private Set<String> loadRepositoryRules(Path filePath)

isRecord

private boolean isRecord(RepositorySystemSession session)

Returns true if given session is recording.

saveRecordedLines

private void saveRecordedLines()

On-close handler that saves recorded rules, if any.