org.apache.archiva.web.mocks

Class MockInvalidRepositoryContentConsumer

java.lang.Object

org.apache.archiva.web.mocks.MockInvalidRepositoryContentConsumer

All Implemented Interfaces:

Consumer, InvalidRepositoryContentConsumer, RepositoryContentConsumer

@Service(value="InvalidRepositoryContentConsumer#mock")
public class MockInvalidRepositoryContentConsumer
extends Object
implements InvalidRepositoryContentConsumer

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
MockInvalidRepositoryContentConsumer()

Method Summary

Modifier and Type	Method and Description
void	addConsumerMonitor(ConsumerMonitor monitor) Add a consumer monitor to the consumer.
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.
boolean	isProcessUnmodified() Whether the consumer should process files that have not been modified since the time passed in to the scan method.
void	processFile(String path) Event indicating a file is to be processed by this consumer.
void	processFile(String path, boolean executeOnEntireRepo)
void	removeConsumerMonitor(ConsumerMonitor monitor) Remove a consumer monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockInvalidRepositoryContentConsumer

public MockInvalidRepositoryContentConsumer()

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.

addConsumerMonitor

public void addConsumerMonitor(ConsumerMonitor monitor)

Description copied from interface: Consumer

Add a consumer monitor to the consumer.

Specified by:

addConsumerMonitor in interface Consumer

Parameters:

monitor - the monitor to add.

removeConsumerMonitor

public void removeConsumerMonitor(ConsumerMonitor monitor)

Description copied from interface: Consumer

Remove a consumer monitor.

Specified by:

removeConsumerMonitor in interface Consumer

Parameters:

monitor - the monitor to remove.

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")

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)

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)

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 executeOnEntireRepo)
                 throws Exception

Specified by:

processFile in interface RepositoryContentConsumer

Parameters:

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

executeOnEntireRepo - 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.

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

isProcessUnmodified

public boolean isProcessUnmodified()

Description copied from interface: RepositoryContentConsumer

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

Specified by:

isProcessUnmodified in interface RepositoryContentConsumer

Returns:

whether to process the unmodified files