Class SummaryFileTrustedChecksumsSource
- All Implemented Interfaces:
TrustedChecksumsSource
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Nested classes/interfaces inherited from interface org.eclipse.aether.spi.checksums.TrustedChecksumsSource
TrustedChecksumsSource.Writer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ConcurrentHashMap
<Path, Boolean> private final ConcurrentHashMap
<Path, ConcurrentHashMap<String, String>> private static final String
private final LocalPathComposer
private static final org.slf4j.Logger
static final String
private final AtomicBoolean
private final RepositorySystemLifecycle
Fields inherited from class org.eclipse.aether.internal.impl.checksum.FileTrustedChecksumsSourceSupport
LOCAL_REPO_PREFIX_DIR
-
Constructor Summary
ConstructorsConstructorDescriptionSummaryFileTrustedChecksumsSource
(LocalPathComposer localPathComposer, RepositorySystemLifecycle repositorySystemLifecycle) -
Method Summary
Modifier and TypeMethodDescriptiondoGetTrustedArtifactChecksums
(RepositorySystemSession session, Artifact artifact, ArtifactRepository artifactRepository, List<ChecksumAlgorithmFactory> checksumAlgorithmFactories) Implementors MUST NOT returnnull
at this point, as this source is enabled.Implementors may override this method and returnTrustedChecksumsSource.Writer
instance.private ConcurrentHashMap
<String, String> loadProvidedChecksums
(Path summaryFile) private void
On-close handler that saves recorded checksums, if any.private Path
summaryFile
(Path basedir, boolean originAware, String repositoryId, String checksumExtension) Returns the summary file path.Methods inherited from class org.eclipse.aether.internal.impl.checksum.FileTrustedChecksumsSourceSupport
configPropKey, getBasedir, getTrustedArtifactChecksums, getTrustedArtifactChecksumsWriter, isEnabled, isOriginAware
-
Field Details
-
NAME
- See Also:
-
CHECKSUMS_FILE_PREFIX
- See Also:
-
LOGGER
private static final org.slf4j.Logger LOGGER -
localPathComposer
-
repositorySystemLifecycle
-
checksums
-
changedChecksums
-
onShutdownHandlerRegistered
-
-
Constructor Details
-
SummaryFileTrustedChecksumsSource
@Inject public SummaryFileTrustedChecksumsSource(LocalPathComposer localPathComposer, RepositorySystemLifecycle repositorySystemLifecycle)
-
-
Method Details
-
doGetTrustedArtifactChecksums
protected Map<String,String> doGetTrustedArtifactChecksums(RepositorySystemSession session, Artifact artifact, ArtifactRepository artifactRepository, List<ChecksumAlgorithmFactory> checksumAlgorithmFactories) Description copied from class:FileTrustedChecksumsSourceSupport
Implementors MUST NOT returnnull
at this point, as this source is enabled.- Specified by:
doGetTrustedArtifactChecksums
in classFileTrustedChecksumsSourceSupport
-
doGetTrustedArtifactChecksumsWriter
protected SummaryFileTrustedChecksumsSource.SummaryFileWriter doGetTrustedArtifactChecksumsWriter(RepositorySystemSession session) Description copied from class:FileTrustedChecksumsSourceSupport
Implementors may override this method and returnTrustedChecksumsSource.Writer
instance.- Overrides:
doGetTrustedArtifactChecksumsWriter
in classFileTrustedChecksumsSourceSupport
-
summaryFile
private Path summaryFile(Path basedir, boolean originAware, String repositoryId, String checksumExtension) Returns the summary file path. The file itself and its parent directories may not exist, this method merely calculate the path. -
loadProvidedChecksums
-
saveRecordedLines
private void saveRecordedLines()On-close handler that saves recorded checksums, if any.
-