Package org.eclipse.aether.internal.impl.checksum

Class SummaryFileTrustedChecksumsSource

  • All Implemented Interfaces:
    org.eclipse.aether.spi.checksums.TrustedChecksumsSource
    @Singleton
@Named("summaryFile")
public final class SummaryFileTrustedChecksumsSource
extends java.lang.Object
    Compact file FileTrustedChecksumsSourceSupport implementation that use specified directory as base directory, where it expects a "summary" file named as "checksums.${checksumExt}" for each checksum algorithm. File format is GNU Coreutils compatible: each line holds checksum followed by two spaces and artifact relative path (from local repository root, without leading "./"). This means that trusted checksums summary file can be used to validate artifacts or generate it using standard GNU tools like GNU sha1sum is (for BSD derivatives same file can be used with -r switch).

    The format supports comments "#" (hash) and empty lines for easier structuring the file content, and both are ignored. Also, their presence makes the summary file incompatible with GNU Coreutils format. On save of the summary file, the comments and empty lines are lost, and file is sorted by path names for easier diffing (2nd column in file).

    The source by default is "origin aware", and it will factor in origin repository ID as well into summary file name, for example "checksums-central.sha256".

    Example commands for managing summary file (in examples will use repository ID "central"):

    • To create summary file: find * -not -name "checksums-central.sha256" -type f -print0 | xargs -0 sha256sum | sort -k 2 > checksums-central.sha256
    • To verify artifacts using summary file: sha256sum --quiet -c checksums-central.sha256

    The checksums summary file is lazily loaded and remains cached during lifetime of the component, so file changes during lifecycle of the component are not picked up. This implementation can be simultaneously used to lookup and also record checksums. The recorded checksums will become visible for every session, and will be flushed at repository system shutdown, merged with existing ones on disk.

    The name of this implementation is "summaryFile".

    Since:
    1.9.0
    See Also:
    sha1sum man page, GNU Coreutils: md5sum

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.eclipse.aether.spi.checksums.TrustedChecksumsSource

        org.eclipse.aether.spi.checksums.TrustedChecksumsSource.Writer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static 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)
      To be used by underlying implementations to form configuration property keys properly scoped.
      protected java.util.Map<java.lang.String,​java.lang.String> doGetTrustedArtifactChecksums​(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact, org.eclipse.aether.repository.ArtifactRepository artifactRepository, java.util.List<org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory> checksumAlgorithmFactories)
      Implementors MUST NOT return null at this point, as this source is enabled.
      protected org.eclipse.aether.internal.impl.checksum.SummaryFileTrustedChecksumsSource.SummaryFileWriter doGetTrustedArtifactChecksumsWriter​(org.eclipse.aether.RepositorySystemSession session)
      Implementors may override this method and return TrustedChecksumsSource.Writer instance.
      protected java.nio.file.Path getBasedir​(org.eclipse.aether.RepositorySystemSession session, boolean mayCreate)
      Uses utility DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null.
      java.util.Map<java.lang.String,​java.lang.String> getTrustedArtifactChecksums​(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.artifact.Artifact artifact, org.eclipse.aether.repository.ArtifactRepository artifactRepository, java.util.List<org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory> checksumAlgorithmFactories)
      This implementation will call into underlying code only if enabled, and will enforce non-null return value.
      org.eclipse.aether.spi.checksums.TrustedChecksumsSource.Writer getTrustedArtifactChecksumsWriter​(org.eclipse.aether.RepositorySystemSession session)
      This implementation will call into underlying code only if enabled.
      protected boolean isEnabled​(org.eclipse.aether.RepositorySystemSession session)
      Returns true if session configuration marks this instance as enabled.
      protected boolean isOriginAware​(org.eclipse.aether.RepositorySystemSession session)
      Returns true if session configuration marks this instance as origin aware.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • doGetTrustedArtifactChecksums

        protected java.util.Map<java.lang.String,​java.lang.String> doGetTrustedArtifactChecksums​(org.eclipse.aether.RepositorySystemSession session,
                                                                                               org.eclipse.aether.artifact.Artifact artifact,
                                                                                               org.eclipse.aether.repository.ArtifactRepository artifactRepository,
                                                                                               java.util.List<org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory> checksumAlgorithmFactories)
        Implementors MUST NOT return null at this point, as this source is enabled.

      • doGetTrustedArtifactChecksumsWriter

        protected org.eclipse.aether.internal.impl.checksum.SummaryFileTrustedChecksumsSource.SummaryFileWriter doGetTrustedArtifactChecksumsWriter​(org.eclipse.aether.RepositorySystemSession session)
        Implementors may override this method and return TrustedChecksumsSource.Writer instance.

      • getTrustedArtifactChecksums

        public java.util.Map<java.lang.String,​java.lang.String> getTrustedArtifactChecksums​(org.eclipse.aether.RepositorySystemSession session,
                                                                                          org.eclipse.aether.artifact.Artifact artifact,
                                                                                          org.eclipse.aether.repository.ArtifactRepository artifactRepository,
                                                                                          java.util.List<org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory> checksumAlgorithmFactories)
        This implementation will call into underlying code only if enabled, and will enforce non-null return value. In worst case, empty map should be returned, meaning "no trusted checksums available".
        Specified by:
        getTrustedArtifactChecksums in interface org.eclipse.aether.spi.checksums.TrustedChecksumsSource

      • getTrustedArtifactChecksumsWriter

        public org.eclipse.aether.spi.checksums.TrustedChecksumsSource.Writer getTrustedArtifactChecksumsWriter​(org.eclipse.aether.RepositorySystemSession session)
        This implementation will call into underlying code only if enabled. Underlying implementation may still choose to return null.
        Specified by:
        getTrustedArtifactChecksumsWriter in interface org.eclipse.aether.spi.checksums.TrustedChecksumsSource

      • configPropKey

        protected java.lang.String configPropKey​(java.lang.String name)
        To be used by underlying implementations to form configuration property keys properly scoped.

      • isEnabled

        protected boolean isEnabled​(org.eclipse.aether.RepositorySystemSession session)
        Returns true if session configuration marks this instance as enabled.

        Default value is false.

      • isOriginAware

        protected boolean isOriginAware​(org.eclipse.aether.RepositorySystemSession session)
        Returns true if session configuration marks this instance as origin aware.

        Default value is true.

      • getBasedir

        protected java.nio.file.Path getBasedir​(org.eclipse.aether.RepositorySystemSession session,
                                        boolean mayCreate)
        Uses utility DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null. The returned Path may not exist, if invoked with mayCreate being false.

        Default value is ${LOCAL_REPOSITORY}/.checksums.

        Returns:
        The Path of basedir, never null.