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

Class RemoteRepositoryFilterSourceSupport

java.lang.Object

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

All Implemented Interfaces:

RemoteRepositoryFilterSource

Direct Known Subclasses:

GroupIdRemoteRepositoryFilterSource, PrefixesRemoteRepositoryFilterSource

public abstract class RemoteRepositoryFilterSourceSupport
extends Object
implements RemoteRepositoryFilterSource

Support class for RemoteRepositoryFilterSource implementations.

Support class for implementing RemoteRepositoryFilterSource. It implements basic support like optional "basedir" calculation, handling of "enabled" flag.

The configuration keys supported:

• aether.remoteRepositoryFilter.${id}.enabled

  (boolean) must be explicitly set to "true" to become enabled

• aether.remoteRepositoryFilter.${id}.basedir

  (string, path) directory from where implementation can use files. If unset, default value is ".remoteRepositoryFilters/${id}" and is resolved from local repository basedir.

Since:

1.9.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_REPOSITORY_KEY_FUNCTION	Experimental: Configuration for "repository key" function.
protected static final String	CONFIG_PROPS_PREFIX
static final String	DEFAULT_REPOSITORY_KEY_FUNCTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteRepositoryFilterSourceSupport(RepositoryKeyFunctionFactory repositoryKeyFunctionFactory)

Method Summary

Modifier and Type	Method	Description
protected Path	getBasedir(RepositorySystemSession session, String defaultValue, String configPropKey, boolean mayCreate)	Uses common DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null.
protected abstract boolean	isEnabled(RepositorySystemSession session)	Returns true if session configuration contains this name set to true.
protected RemoteRepository	normalizeRemoteRepository(RepositorySystemSession session, RemoteRepository remoteRepository)	We use remote repositories as keys, so normalize them.
protected String	repositoryKey(RepositorySystemSession session, RemoteRepository repository)	Returns repository key to be used on file system layout.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilterSource

getRemoteRepositoryFilter

Field Details

CONFIG_PROPS_PREFIX

protected static final String CONFIG_PROPS_PREFIX

See Also:

• Constant Field Values

CONFIG_PROP_REPOSITORY_KEY_FUNCTION

public static final String CONFIG_PROP_REPOSITORY_KEY_FUNCTION

Experimental: Configuration for "repository key" function. Note: repository key functions other than "nid" produce repository keys will be way different that those produced with previous versions or without this option enabled. Filter uses this key function to lay down and look up files to use in filtering.

Since:

2.0.14

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

DEFAULT_REPOSITORY_KEY_FUNCTION

DEFAULT_REPOSITORY_KEY_FUNCTION

public static final String DEFAULT_REPOSITORY_KEY_FUNCTION

See Also:

• Constant Field Values

Constructor Details

RemoteRepositoryFilterSourceSupport

protected RemoteRepositoryFilterSourceSupport(RepositoryKeyFunctionFactory repositoryKeyFunctionFactory)

Method Details

isEnabled

protected abstract boolean isEnabled(RepositorySystemSession session)

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

Default is true.

getBasedir

protected Path getBasedir(RepositorySystemSession session,
 String defaultValue,
 String configPropKey,
 boolean mayCreate)

Uses common DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null. The returned Path may not exists, if invoked with mayCreate being false.

Default value is ${LOCAL_REPOSITORY}/.checksums.

Returns:

The Path of basedir, never null.

normalizeRemoteRepository

protected RemoteRepository normalizeRemoteRepository(RepositorySystemSession session,
 RemoteRepository remoteRepository)

We use remote repositories as keys, so normalize them.

Since:

2.0.14

See Also:

• RemoteRepository.toBareRemoteRepository()

repositoryKey

protected String repositoryKey(RepositorySystemSession session,
 RemoteRepository repository)

Returns repository key to be used on file system layout.

Since:

2.0.14