org.apache.archiva.consumers.core

Class ValidateChecksumConsumer

java.lang.Object

org.apache.archiva.consumers.AbstractMonitoredConsumer

org.apache.archiva.consumers.core.ValidateChecksumConsumer

All Implemented Interfaces:

Consumer, KnownRepositoryContentConsumer, RepositoryContentConsumer

@Service(value="knownRepositoryContentConsumer#validate-checksums")
 @Scope(value="prototype")
public class ValidateChecksumConsumer
extends AbstractMonitoredConsumer
implements KnownRepositoryContentConsumer

ValidateChecksumConsumer - validate the provided checksum against the file it represents.

Field Summary

Fields

Modifier and Type	Field and Description
private List<org.codehaus.plexus.digest.Digester>	allDigesters
private org.codehaus.plexus.digest.ChecksumFile	checksum
private static String	CHECKSUM_DIGESTER_FAILURE
private static String	CHECKSUM_IO_ERROR
private static String	CHECKSUM_NOT_FOUND
private String	description
private DigesterUtils	digesterUtils
private String	id
private List<String>	includes
private org.slf4j.Logger	log
private static String	NOT_VALID_CHECKSUM
private PlexusSisuBridge	plexusSisuBridge
private File	repositoryDir

Constructor Summary

Constructors

Constructor and Description
ValidateChecksumConsumer()

Method Summary

Modifier and Type	Method and Description
void	beginScan(ManagedRepository repository, Date whenGathered) Event that triggers at the beginning of a scan.
void	beginScan(ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo) Event that triggers at the beginning of a scan, where you can also indicate whether the consumers will be executed on an entire repository or on a specific resource.
void	completeScan() Event that triggers on the completion of a scan.
void	completeScan(boolean executeOnEntireRepo)
String	getDescription() The human readable description for this consumer.
List<String>	getExcludes() Get the list of excluded file patterns for this consumer.
String	getId() This is the id for the consumer.
List<String>	getIncludes() Get the list of included file patterns for this consumer.
void	initialize()
void	processFile(String path) Event indicating a file is to be processed by this consumer.
void	processFile(String path, boolean executeOnEntireReDpo)

Methods inherited from class org.apache.archiva.consumers.AbstractMonitoredConsumer

addConsumerMonitor, getDefaultArtifactExclusions, isProcessUnmodified, removeConsumerMonitor, triggerConsumerError, triggerConsumerInfo, triggerConsumerWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.consumers.RepositoryContentConsumer

isProcessUnmodified

Methods inherited from interface org.apache.archiva.consumers.Consumer

addConsumerMonitor, removeConsumerMonitor

Field Detail

log

private org.slf4j.Logger log

NOT_VALID_CHECKSUM

private static final String NOT_VALID_CHECKSUM

See Also:

Constant Field Values

CHECKSUM_NOT_FOUND

private static final String CHECKSUM_NOT_FOUND

See Also:

Constant Field Values

CHECKSUM_DIGESTER_FAILURE

private static final String CHECKSUM_DIGESTER_FAILURE

See Also:

Constant Field Values

CHECKSUM_IO_ERROR

private static final String CHECKSUM_IO_ERROR

See Also:

Constant Field Values

id

private String id

description

private String description

checksum

private org.codehaus.plexus.digest.ChecksumFile checksum

allDigesters

private List<org.codehaus.plexus.digest.Digester> allDigesters

plexusSisuBridge

@Inject
private PlexusSisuBridge plexusSisuBridge

digesterUtils

@Inject
private DigesterUtils digesterUtils

repositoryDir

private File repositoryDir

includes

private List<String> includes

Constructor Detail

ValidateChecksumConsumer

public ValidateChecksumConsumer()

Method Detail

getId

public String getId()

Description copied from interface: Consumer

This is the id for the consumer.

Specified by:

getId in interface Consumer

Returns:

the consumer id.

getDescription

public String getDescription()

Description copied from interface: Consumer

The human readable description for this consumer.

Specified by:

getDescription in interface Consumer

Returns:

the human readable description for this consumer.

beginScan

public void beginScan(ManagedRepository repository,
                      Date whenGathered)
               throws ConsumerException

Description copied from interface: RepositoryContentConsumer

Event that triggers at the beginning of a scan.

NOTE: This would be a good place to initialize the consumer, to lock any resources, and to generally start tracking the scan as a whole.

Specified by:

beginScan in interface RepositoryContentConsumer

Parameters:

repository - the repository that this consumer is being used for.

whenGathered - the start of the repository scan

Throws:

ConsumerException - if there was a problem with using the provided repository with the consumer.

beginScan

public void beginScan(ManagedRepository repository,
                      Date whenGathered,
                      boolean executeOnEntireRepo)
               throws ConsumerException

Description copied from interface: RepositoryContentConsumer

Event that triggers at the beginning of a scan, where you can also indicate whether the consumers will be executed on an entire repository or on a specific resource.

Specified by:

beginScan in interface RepositoryContentConsumer

Parameters:

repository - the repository that this consumer is being used for.

whenGathered - the start of the repository scan

executeOnEntireRepo - flags whether the consumer will be executed on an entire repository or just on a specific resource

Throws:

ConsumerException - if there was a problem with using the provided repository with the consumer.

See Also:

RepositoryContentConsumer.beginScan(ManagedRepository, java.util.Date)

completeScan

public void completeScan()

Description copied from interface: RepositoryContentConsumer

Event that triggers on the completion of a scan.

NOTE: If the consumer opted to batch up processing requests in the RepositoryContentConsumer.processFile(String) event this would be the last opportunity to drain any processing queue's.

Specified by:

completeScan in interface RepositoryContentConsumer

completeScan

public void completeScan(boolean executeOnEntireRepo)

Specified by:

completeScan in interface RepositoryContentConsumer

Parameters:

executeOnEntireRepo - flags whether the consumer will be executed on an entire repository or just on a specific resource

getExcludes

public List<String> getExcludes()

Description copied from interface: RepositoryContentConsumer

Get the list of excluded file patterns for this consumer.

Specified by:

getExcludes in interface RepositoryContentConsumer

Returns:

the list of String patterns. (example: "**/*.pom") - (can be null for no exclusions)

getIncludes

public List<String> getIncludes()

Description copied from interface: RepositoryContentConsumer

Get the list of included file patterns for this consumer.

Specified by:

getIncludes in interface RepositoryContentConsumer

Returns:

the list of String patterns. (example: "**/*.pom")

processFile

public void processFile(String path)
                 throws ConsumerException

Description copied from interface: RepositoryContentConsumer

Event indicating a file is to be processed by this consumer.

NOTE: The consumer does not need to process the file immediately, can can opt to queue and/or track the files to be processed in batch. Just be sure to complete the processing by the RepositoryContentConsumer.completeScan() event.

Specified by:

processFile in interface RepositoryContentConsumer

Parameters:

path - the relative file path (in the repository) to process.

Throws:

ConsumerException - if there was a problem processing this file.

processFile

public void processFile(String path,
                        boolean executeOnEntireReDpo)
                 throws Exception

Specified by:

processFile in interface RepositoryContentConsumer

Parameters:

path - the relative file path (in the repository) to process.

executeOnEntireReDpo - flags whether the consumer will be executed on an entire repository or just on a specific resource

Throws:

Exception - if there was a problem processing this file.

initialize

@PostConstruct
public void initialize()
                               throws PlexusSisuBridgeException

Throws:

PlexusSisuBridgeException