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

Class 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String CONFIG_PROPS_PREFIX  
      protected org.slf4j.Logger logger  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected RemoteRepositoryFilterSourceSupport​(org.eclipse.aether.spi.remoterepo.RepositoryKeyFunctionFactory repositoryKeyFunctionFactory)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.nio.file.Path getBasedir​(org.eclipse.aether.RepositorySystemSession session, java.lang.String defaultValue, java.lang.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​(org.eclipse.aether.RepositorySystemSession session)
      Returns true if session configuration contains this name set to true.
      protected org.eclipse.aether.repository.RemoteRepository normalizeRemoteRepository​(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.repository.RemoteRepository remoteRepository)
      We use remote repositories as keys, so normalize them.
      protected java.util.List<java.lang.String> repositoryKeys​(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.repository.RemoteRepository repository)
      Returns repository keys to be used on file system layout for user provided files.

      • 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​(org.eclipse.aether.spi.remoterepo.RepositoryKeyFunctionFactory repositoryKeyFunctionFactory)

    • Method Detail

      • isEnabled

        protected abstract boolean isEnabled​(org.eclipse.aether.RepositorySystemSession session)
        Returns true if session configuration contains this name set to true.

        Default is true.

      • getBasedir

        protected java.nio.file.Path getBasedir​(org.eclipse.aether.RepositorySystemSession session,
                                        java.lang.String defaultValue,
                                        java.lang.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 org.eclipse.aether.repository.RemoteRepository normalizeRemoteRepository​(org.eclipse.aether.RepositorySystemSession session,
                                                                                   org.eclipse.aether.repository.RemoteRepository remoteRepository)
        We use remote repositories as keys, so normalize them.
        Since:
        2.0.14
        See Also:
        RemoteRepository.toBareRemoteRepository()

      • repositoryKeys

        protected java.util.List<java.lang.String> repositoryKeys​(org.eclipse.aether.RepositorySystemSession session,
                                                          org.eclipse.aether.repository.RemoteRepository repository)
        Returns repository keys to be used on file system layout for user provided files. They are ordered as "most specific" (using RepositoryKeyFunctionFactory.trackingRepositoryKeyFunction(RepositorySystemSession)) to simple "id based" one. This allows user to keep using plain ID, but also to provide very narrowly targeted input files, when needed.
        Since:
        2.0.14