RemoteRepositoryFilterSourceSupport

java.lang.Object
- org.eclipse.aether.internal.impl.filter.RemoteRepositoryFilterSourceSupport

All Implemented Interfaces:

org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilterSource

Direct Known Subclasses:

GroupIdRemoteRepositoryFilterSource, PrefixesRemoteRepositoryFilterSource
```
public abstract class RemoteRepositoryFilterSourceSupport
extends java.lang.Object
implements org.eclipse.aether.spi.connector.filter.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.

Constructor Summary

Constructors
Modifier Constructor Description

protected RemoteRepositoryFilterSourceSupport(java.lang.String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`configPropKey(java.lang.String name)`	Utility method to create scoped configuration property key of given name.
`protected java.nio.file.Path`	`getBasedir(org.eclipse.aether.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(org.eclipse.aether.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

- Constructor Detail
  - RemoteRepositoryFilterSourceSupport
```
protected RemoteRepositoryFilterSourceSupport(java.lang.String name)
```
- Method Detail
  - configPropKey
```
protected java.lang.String configPropKey(java.lang.String name)
```
    Utility method to create scoped configuration property key of given name.
  - isEnabled
```
protected boolean isEnabled(org.eclipse.aether.RepositorySystemSession session)
```
    Returns true if session configuration contains this name set to true.
    Default is false.
  - getBasedir
```
protected java.nio.file.Path getBasedir(org.eclipse.aether.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.