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

org.apache.archiva.consumers.lucene
Class LuceneCleanupRemoveIndexedConsumer

java.lang.Object
  org.apache.maven.archiva.consumers.AbstractMonitoredConsumer
      org.apache.archiva.consumers.lucene.LuceneCleanupRemoveIndexedConsumer

All Implemented Interfaces:

Consumer, ArchivaArtifactConsumer, DatabaseCleanupConsumer

public class LuceneCleanupRemoveIndexedConsumer
extends AbstractMonitoredConsumer
implements DatabaseCleanupConsumer

LuceneCleanupRemoveIndexedConsumer Clean up the index of artifacts that are no longer existing in the file system (managed repositories).

Constructor Summary

LuceneCleanupRemoveIndexedConsumer(RepositoryContentFactory repoFactory, ArchivaTaskScheduler scheduler)

Method Summary

void	beginScan() Event that triggers at the beginning of a scan.
void	completeScan() Event that triggers on the completion of a scan.
java.lang.String	getDescription() The human readable description for this consumer.
java.lang.String	getId() This is the id for the consumer.
java.util.List<java.lang.String>	getIncludedTypes() Get the list of included file patterns for this consumer.
boolean	isPermanent() Flag indicating permanance of consumer.
void	processArchivaArtifact(ArchivaArtifact artifact) Event indicating an ArchivaArtifact is to be processed by this consumer.
void	setRepositoryContentFactory(RepositoryContentFactory repoFactory)

Methods inherited from class org.apache.maven.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.maven.archiva.consumers.Consumer

addConsumerMonitor, removeConsumerMonitor

Constructor Detail

LuceneCleanupRemoveIndexedConsumer

public LuceneCleanupRemoveIndexedConsumer(RepositoryContentFactory repoFactory,
                                          ArchivaTaskScheduler scheduler)

Method Detail

beginScan

public void beginScan()

Description copied from interface: ArchivaArtifactConsumer

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 ArchivaArtifactConsumer

completeScan

public void completeScan()

Description copied from interface: ArchivaArtifactConsumer

Event that triggers on the completion of a scan.

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

Specified by:

completeScan in interface ArchivaArtifactConsumer

getIncludedTypes

public java.util.List<java.lang.String> getIncludedTypes()

Description copied from interface: ArchivaArtifactConsumer

Get the list of included file patterns for this consumer.

Specified by:

getIncludedTypes in interface ArchivaArtifactConsumer

Returns:

the list of (String) artifact types to process.

processArchivaArtifact

public void processArchivaArtifact(ArchivaArtifact artifact)
                            throws ConsumerException

Description copied from interface: ArchivaArtifactConsumer

Event indicating an ArchivaArtifact is to be processed by this consumer.

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

Specified by:

processArchivaArtifact in interface ArchivaArtifactConsumer

Throws:

ConsumerException - if there was a problem processing this file.

getDescription

public java.lang.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.

getId

public java.lang.String getId()

Description copied from interface: Consumer

This is the id for the consumer.

Specified by:

getId in interface Consumer

Returns:

the consumer id.

isPermanent

public boolean isPermanent()

Description copied from interface: Consumer

Flag indicating permanance of consumer. (if it can be disabled or not)

Specified by:

isPermanent in interface Consumer

Returns:

true indicating that consumer is permanent and cannot be disabled.

setRepositoryContentFactory

public void setRepositoryContentFactory(RepositoryContentFactory repoFactory)