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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RemoteRepositoryFilterSourceSupport.SimpleResult	Simple RemoteRepositoryFilter.Result immutable implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	CONF_NAME_BASEDIR
private static final String	CONFIG_PROP_PREFIX
(package private) static final String	LOCAL_REPO_PREFIX_DIR
private final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteRepositoryFilterSourceSupport(String name)

Method Summary

Modifier and Type	Method	Description
protected String	configPropKey(String name)	Utility method to create scoped configuration property key of given name.
protected Path	getBasedir(RepositorySystemSession session, boolean mayCreate)	Uses common DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null.
protected boolean	isEnabled(RepositorySystemSession session)	Returns true if session configuration contains this name set to true.

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_PROP_PREFIX

private static final String CONFIG_PROP_PREFIX

See Also:

• Constant Field Values

CONF_NAME_BASEDIR

private static final String CONF_NAME_BASEDIR

See Also:

• Constant Field Values

LOCAL_REPO_PREFIX_DIR

static final String LOCAL_REPO_PREFIX_DIR

See Also:

• Constant Field Values

name

private final String name

Constructor Details

RemoteRepositoryFilterSourceSupport

protected RemoteRepositoryFilterSourceSupport(String name)

Method Details

configPropKey

protected String configPropKey(String name)

Utility method to create scoped configuration property key of given name.

isEnabled

protected boolean isEnabled(RepositorySystemSession session)

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

Default is false.

getBasedir

protected Path getBasedir(RepositorySystemSession session,
 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.