ArchivaMetadataCreationConsumer (Archiva

java.lang.Object
- org.apache.archiva.consumers.AbstractMonitoredConsumer
- - org.apache.archiva.consumers.metadata.ArchivaMetadataCreationConsumer

All Implemented Interfaces:: Consumer, KnownRepositoryContentConsumer, RepositoryContentConsumer, org.apache.archiva.redback.components.registry.RegistryListener

@Service(value="knownRepositoryContentConsumer#create-archiva-metadata")
@Scope(value="prototype")
public class ArchivaMetadataCreationConsumer
extends AbstractMonitoredConsumer
implements KnownRepositoryContentConsumer, org.apache.archiva.redback.components.registry.RegistryListener

Take an artifact off of disk and put it into the metadata repository.

Field Summary

Fields
Modifier and Type	Field and Description
`private ArchivaConfiguration`	`configuration`
`private String`	`description`
`private FileTypes`	`filetypes`
`private String`	`id`
`private List<String>`	`includes`
`private static org.slf4j.Logger`	`log`
`private String`	`repoId`
`private RepositorySessionFactory`	`repositorySessionFactory` FIXME: this could be multiple implementations and needs to be configured.
`private RepositoryStorage`	`repositoryStorage` FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo.
`private Date`	`whenGathered`

Constructor Summary

Constructors
Constructor and Description

ArchivaMetadataCreationConsumer()

Constructors
Constructor and Description
`ArchivaMetadataCreationConsumer()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterConfigurationChange(org.apache.archiva.redback.components.registry.Registry registry, String propertyName, Object propertyValue)`
`void`	`beforeConfigurationChange(org.apache.archiva.redback.components.registry.Registry registry, String propertyName, Object propertyValue)`
`void`	`beginScan(ManagedRepository repo, 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()`
`private void`	`initIncludes()`
`void`	`processFile(String path)` Event indicating a file is to be processed by this consumer.
`void`	`processFile(String path, boolean executeOnEntireRepo)`

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
  - id
```
private String id
```
  - description
```
private String description
```
  - configuration
```
@Inject
private ArchivaConfiguration configuration
```
  - filetypes
```
@Inject
private FileTypes filetypes
```
  - whenGathered
```
private Date whenGathered
```
  - includes
```
private List<String> includes
```
  - repositorySessionFactory
```
@Inject
private RepositorySessionFactory repositorySessionFactory
```
    FIXME: this could be multiple implementations and needs to be configured.
  - repositoryStorage
```
@Inject
@Named(value="repositoryStorage#maven2")
private RepositoryStorage repositoryStorage
```
    FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo. Change to a factory.
  - log
```
private static final org.slf4j.Logger log
```
  - repoId
```
private String repoId
```
- Constructor Detail
  - ArchivaMetadataCreationConsumer
```
public ArchivaMetadataCreationConsumer()
```
- 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.
  - 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")
  - beginScan
```
public void beginScan(ManagedRepository repo,
             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:
    repo - 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 ConsumerException
```
    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:
    
    ConsumerException
  - 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
  - afterConfigurationChange
```
public void afterConfigurationChange(org.apache.archiva.redback.components.registry.Registry registry,
                            String propertyName,
                            Object propertyValue)
```
    Specified by:
    
    afterConfigurationChange in interface org.apache.archiva.redback.components.registry.RegistryListener
  - beforeConfigurationChange
```
public void beforeConfigurationChange(org.apache.archiva.redback.components.registry.Registry registry,
                             String propertyName,
                             Object propertyValue)
```
    Specified by:
    
    beforeConfigurationChange in interface org.apache.archiva.redback.components.registry.RegistryListener
  - initIncludes
```
private void initIncludes()
```
  - initialize
```
@PostConstruct
public void initialize()
```

Class ArchivaMetadataCreationConsumer

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Field Detail

id

description

configuration

filetypes

whenGathered

includes

repositorySessionFactory

repositoryStorage

log

repoId

Constructor Detail

ArchivaMetadataCreationConsumer

Method Detail

getId

getDescription

getExcludes

getIncludes

beginScan

beginScan

processFile

processFile

completeScan

completeScan

afterConfigurationChange

beforeConfigurationChange

initIncludes

initialize