Package org.eclipse.aether.internal.impl.resolution

Class TrustedChecksumsArtifactResolverPostProcessor

java.lang.Object

org.eclipse.aether.internal.impl.resolution.ArtifactResolverPostProcessorSupport

org.eclipse.aether.internal.impl.resolution.TrustedChecksumsArtifactResolverPostProcessor

All Implemented Interfaces:

org.eclipse.aether.spi.resolution.ArtifactResolverPostProcessor

@Singleton
@Named("trustedChecksums")
public final class TrustedChecksumsArtifactResolverPostProcessor
extends ArtifactResolverPostProcessorSupport

Artifact resolver processor that verifies the checksums of all resolved artifacts against trusted checksums. Is also able to "record" (calculate and write them) to trusted checksum sources, that do support this operation.

It uses a list of ChecksumAlgorithmFactoryies to work with, by default SHA-1.

Configuration keys:

• aether.artifactResolver.postProcessor.trustedChecksums.checksumAlgorithms - Comma separated list of ChecksumAlgorithmFactory names to use (default "SHA-1").
• aether.artifactResolver.postProcessor.trustedChecksums.failIfMissing - To fail if artifact being validated is missing a trusted checksum (default false).
• aether.artifactResolver.postProcessor.trustedChecksums.snapshots - Should snapshot artifacts be handled (validated or recorded). Snapshots are by "best practice" in-house produced, hence should be trusted (default false).
• aether.artifactResolver.postProcessor.trustedChecksums.record - If this value set to true, this component with not validate but "record" encountered artifact checksums instead (default false).

This component uses TrustedChecksumsSource as source of checksums for validation and also to "record" the calculated checksums. To have this component usable, there must exist at least one enabled checksum source. In case of multiple checksum sources enabled, ALL of them are used as source for validation or recording. This implies that if two enabled checksum sources "disagree" about an artifact checksum, the validation failure is inevitable.

Since:

1.9.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PROP_CHECKSUM_ALGORITHMS	The checksum algorithms to apply during post-processing as comma separated list.
static final String	CONFIG_PROP_ENABLED	Is post processor enabled.
static final String	CONFIG_PROP_FAIL_IF_MISSING	Should post processor fail resolution if checksum is missing?
static final String	CONFIG_PROP_RECORD	Should post processor go into "record" mode (and collect checksums instead of validate them)?
static final String	CONFIG_PROP_SNAPSHOTS	Should post processor process snapshots as well?
static final String	DEFAULT_CHECKSUM_ALGORITHMS
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
TrustedChecksumsArtifactResolverPostProcessor(org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactorySelector checksumAlgorithmFactorySelector, Map<String,org.eclipse.aether.spi.checksums.TrustedChecksumsSource> trustedChecksumsSources)

Method Summary

Modifier and Type	Method	Description
protected void	doPostProcess(org.eclipse.aether.RepositorySystemSession session, List<org.eclipse.aether.resolution.ArtifactResult> artifactResults)
protected boolean	isEnabled(org.eclipse.aether.RepositorySystemSession session)	Returns true if session configuration marks this instance as enabled.

Methods inherited from class org.eclipse.aether.internal.impl.resolution.ArtifactResolverPostProcessorSupport

postProcess

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 post processor enabled.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

CONFIG_PROP_CHECKSUM_ALGORITHMS

public static final String CONFIG_PROP_CHECKSUM_ALGORITHMS

The checksum algorithms to apply during post-processing as comma separated list.

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

String

Default value:

DEFAULT_CHECKSUM_ALGORITHMS

DEFAULT_CHECKSUM_ALGORITHMS

public static final String DEFAULT_CHECKSUM_ALGORITHMS

See Also:

• Constant Field Values

CONFIG_PROP_FAIL_IF_MISSING

public static final String CONFIG_PROP_FAIL_IF_MISSING

Should post processor fail resolution if checksum is missing?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

CONFIG_PROP_SNAPSHOTS

public static final String CONFIG_PROP_SNAPSHOTS

Should post processor process snapshots as well?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

CONFIG_PROP_RECORD

public static final String CONFIG_PROP_RECORD

Should post processor go into "record" mode (and collect checksums instead of validate them)?

See Also:

• Constant Field Values

Sourced from:

RepositorySystemSession.getConfigProperties()

Value type:

Boolean

Default value:

false

Constructor Details

TrustedChecksumsArtifactResolverPostProcessor

@Inject
public TrustedChecksumsArtifactResolverPostProcessor(org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactorySelector checksumAlgorithmFactorySelector,
 Map<String,org.eclipse.aether.spi.checksums.TrustedChecksumsSource> trustedChecksumsSources)

Method Details

isEnabled

protected boolean isEnabled(org.eclipse.aether.RepositorySystemSession session)

Description copied from class: ArtifactResolverPostProcessorSupport

Returns true if session configuration marks this instance as enabled.

Default value is false.

Specified by:

isEnabled in class ArtifactResolverPostProcessorSupport

doPostProcess

protected void doPostProcess(org.eclipse.aether.RepositorySystemSession session,
 List<org.eclipse.aether.resolution.ArtifactResult> artifactResults)

Specified by:

doPostProcess in class ArtifactResolverPostProcessorSupport