This project has retired. For details please refer to its Attic page.

org.apache.maven.archiva.consumers
Interface RepositoryContentConsumer

All Superinterfaces:

Consumer

All Known Subinterfaces:

InvalidRepositoryContentConsumer, KnownRepositoryContentConsumer

All Known Implementing Classes:

ArtifactMissingChecksumsConsumer, ArtifactUpdateDatabaseConsumer, AutoRemoveConsumer, AutoRenameConsumer, DependencyTreeGeneratorConsumer, LegacyConverterArtifactConsumer, MetadataUpdaterConsumer, NexusIndexerConsumer, RepositoryPurgeConsumer, ValidateChecksumConsumer

public interface RepositoryContentConsumer
extends Consumer

A consumer of content (files) in the repository.

Method Summary

void	beginScan(org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration repository, java.util.Date whenGathered) Event that triggers at the beginning of a scan.
void	beginScan(org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration repository, java.util.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)
java.util.List<java.lang.String>	getExcludes() Get the list of excluded file patterns for this consumer.
java.util.List<java.lang.String>	getIncludes() Get the list of included file patterns for this consumer.
boolean	isProcessUnmodified() Whether the consumer should process files that have not been modified since the time passed in to the scan method.
void	processFile(java.lang.String path) Event indicating a file is to be processed by this consumer.
void	processFile(java.lang.String path, boolean executeOnEntireRepo)

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

addConsumerMonitor, getDescription, getId, isPermanent, removeConsumerMonitor

Method Detail

getIncludes

java.util.List<java.lang.String> getIncludes()

Get the list of included file patterns for this consumer.

Returns:

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

getExcludes

java.util.List<java.lang.String> getExcludes()

Get the list of excluded file patterns for this consumer.

Returns:

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

beginScan

void beginScan(org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration repository,
               java.util.Date whenGathered)
               throws ConsumerException

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.

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

void beginScan(org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration repository,
               java.util.Date whenGathered,
               boolean executeOnEntireRepo)
               throws ConsumerException

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.

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:

beginScan(org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration, java.util.Date )

processFile

void processFile(java.lang.String path)
                 throws ConsumerException

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 completeScan() event.

Parameters:

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

Throws:

ConsumerException - if there was a problem processing this file.

processFile

void processFile(java.lang.String path,
                 boolean executeOnEntireRepo)
                 throws java.lang.Exception

Parameters:

path -

executeOnEntireRepo -

Throws:

java.lang.Exception

completeScan

void completeScan()

Event that triggers on the completion of a scan.

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

completeScan

void completeScan(boolean executeOnEntireRepo)

Parameters:

executeOnEntireRepo -

Throws:

java.lang.Exception

isProcessUnmodified

boolean isProcessUnmodified()

Whether the consumer should process files that have not been modified since the time passed in to the scan method.

Returns:

whether to process the unmodified files