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

Class SparseDirectoryTrustedChecksumsSource

java.lang.Object

org.eclipse.aether.internal.impl.checksum.SparseDirectoryTrustedChecksumsSource

All Implemented Interfaces:

TrustedChecksumsSource

@Singleton
@Named("sparseDirectory")
public final class SparseDirectoryTrustedChecksumsSource
extends Object

Sparse file FileTrustedChecksumsSourceSupport implementation that use specified directory as base directory, where it expects artifacts checksums on standard Maven2 "local" layout. This implementation uses Artifact coordinates solely to form path from basedir, pretty much as Maven local repository does.

The source by default is "origin aware", it will factor in origin repository ID as well into base directory name (for example ".checksums/central/...").

The checksums files are directly loaded from disk, so in-flight file changes during lifecycle of session are picked up. This implementation can be simultaneously used to lookup and also write checksums. The written checksums will become visible across all sessions right after the moment they were written.

The name of this implementation is "sparseDirectory".

Since:

1.9.0

See Also:

• LocalPathComposer

Nested Class Summary

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

TrustedChecksumsSource.Writer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_BASEDIR	The basedir where checksums are.
static final String	CONFIG_PROP_ENABLED	Is checksum source enabled?
static final String	CONFIG_PROP_ORIGIN_AWARE	Is source origin aware?
static final String	LOCAL_REPO_PREFIX_DIR
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
SparseDirectoryTrustedChecksumsSource(FileProcessor fileProcessor, LocalPathComposer localPathComposer)

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	doGetTrustedArtifactChecksums(RepositorySystemSession session, Artifact artifact, ArtifactRepository artifactRepository, List<ChecksumAlgorithmFactory> checksumAlgorithmFactories)	Implementors MUST NOT return null at this point, as this source is enabled.
protected TrustedChecksumsSource.Writer	doGetTrustedArtifactChecksumsWriter(RepositorySystemSession session)	Implementors may override this method and return TrustedChecksumsSource.Writer instance.
protected Path	getBasedir(RepositorySystemSession session, String defaultValue, String configPropKey, boolean mayCreate)	Uses utility DirectoryUtils.resolveDirectory(RepositorySystemSession, String, String, boolean) to calculate (and maybe create) basedir for this implementation, never returns null.
Map<String,String>	getTrustedArtifactChecksums(RepositorySystemSession session, Artifact artifact, ArtifactRepository artifactRepository, List<ChecksumAlgorithmFactory> checksumAlgorithmFactories)	This implementation will call into underlying code only if enabled, and will enforce non-null return value.
TrustedChecksumsSource.Writer	getTrustedArtifactChecksumsWriter(RepositorySystemSession session)	This implementation will call into underlying code only if enabled.
protected boolean	isEnabled(RepositorySystemSession session)	Returns true if session configuration marks this instance as enabled.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CONFIG_PROP_ENABLED

public static final String CONFIG_PROP_ENABLED

Is checksum source enabled?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

CONFIG_PROP_BASEDIR

public static final String CONFIG_PROP_BASEDIR

The basedir where checksums are. If relative, is resolved from local repository root.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

LOCAL_REPO_PREFIX_DIR

LOCAL_REPO_PREFIX_DIR

public static final String LOCAL_REPO_PREFIX_DIR

See Also:

• Constant Field Values

CONFIG_PROP_ORIGIN_AWARE

public static final String CONFIG_PROP_ORIGIN_AWARE

Is source origin aware?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

true

Constructor Details

SparseDirectoryTrustedChecksumsSource

@Inject
public SparseDirectoryTrustedChecksumsSource(FileProcessor fileProcessor,
 LocalPathComposer localPathComposer)

Method Details

isEnabled

protected boolean isEnabled(RepositorySystemSession session)

Returns true if session configuration marks this instance as enabled.

Default value is false.

doGetTrustedArtifactChecksums

protected Map<String,String> doGetTrustedArtifactChecksums(RepositorySystemSession session,
 Artifact artifact,
 ArtifactRepository artifactRepository,
 List<ChecksumAlgorithmFactory> checksumAlgorithmFactories)

Implementors MUST NOT return null at this point, as this source is enabled.

doGetTrustedArtifactChecksumsWriter

protected TrustedChecksumsSource.Writer doGetTrustedArtifactChecksumsWriter(RepositorySystemSession session)

Implementors may override this method and return TrustedChecksumsSource.Writer instance.

getTrustedArtifactChecksums

public Map<String,String> getTrustedArtifactChecksums(RepositorySystemSession session,
 Artifact artifact,
 ArtifactRepository artifactRepository,
 List<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 TrustedChecksumsSource

Parameters:

session - The repository system session, never null.

artifact - The artifact we want checksums for, never null.

artifactRepository - The origin repository: local, workspace, remote repository, never null.

checksumAlgorithmFactories - The checksum algorithms that are expected, never null.

Returns:

Map of expected checksums, or null if not enabled.

getTrustedArtifactChecksumsWriter

public TrustedChecksumsSource.Writer getTrustedArtifactChecksumsWriter(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 TrustedChecksumsSource

getBasedir

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