1 package org.apache.archiva.consumers.metadata;
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
22 import org.apache.archiva.metadata.model.ArtifactMetadata;
23 import org.apache.archiva.metadata.model.ProjectMetadata;
24 import org.apache.archiva.metadata.model.ProjectVersionMetadata;
25 import org.apache.archiva.metadata.repository.MetadataRepository;
26 import org.apache.archiva.metadata.repository.MetadataRepositoryException;
27 import org.apache.archiva.metadata.repository.RepositorySession;
28 import org.apache.archiva.metadata.repository.RepositorySessionFactory;
29 import org.apache.archiva.metadata.repository.storage.RepositoryStorage;
30 import org.apache.archiva.metadata.repository.storage.RepositoryStorageMetadataInvalidException;
31 import org.apache.archiva.metadata.repository.storage.RepositoryStorageMetadataNotFoundException;
32 import org.apache.maven.archiva.common.utils.VersionUtil;
33 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
34 import org.apache.maven.archiva.configuration.ConfigurationNames;
35 import org.apache.maven.archiva.configuration.FileTypes;
36 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
37 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
38 import org.apache.maven.archiva.consumers.ConsumerException;
39 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
40 import org.codehaus.plexus.registry.Registry;
41 import org.codehaus.plexus.registry.RegistryListener;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44 import org.springframework.context.annotation.Scope;
45 import org.springframework.stereotype.Service;
47 import javax.annotation.PostConstruct;
48 import javax.inject.Inject;
49 import javax.inject.Named;
50 import java.util.ArrayList;
51 import java.util.Date;
52 import java.util.List;
55 * Take an artifact off of disk and put it into the metadata repository.
57 * @version $Id: ArtifactUpdateDatabaseConsumer.java 718864 2008-11-19 06:33:35Z brett $
59 @Service("knownRepositoryContentConsumer#create-archiva-metadata")
61 public class ArchivaMetadataCreationConsumer
62 extends AbstractMonitoredConsumer
63 implements KnownRepositoryContentConsumer, RegistryListener
66 * plexus.configuration default-value="create-archiva-metadata"
68 private String id = "create-archiva-metadata";
71 * plexus.configuration default-value="Create basic metadata for Archiva to be able to reference the artifact"
73 private String description = "Create basic metadata for Archiva to be able to reference the artifact";
78 private ArchivaConfiguration configuration;
83 private FileTypes filetypes;
85 private Date whenGathered;
87 private List<String> includes = new ArrayList<String>();
90 * FIXME: can be of other types
94 private RepositorySessionFactory repositorySessionFactory;
97 * FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo. Change to a
102 @Named(value = "repositoryStorage#maven2")
103 private RepositoryStorage repositoryStorage;
105 private static final Logger log = LoggerFactory.getLogger( ArchivaMetadataCreationConsumer.class );
107 private String repoId;
109 public String getId()
114 public String getDescription()
116 return this.description;
119 public boolean isPermanent()
124 public List<String> getExcludes()
126 return getDefaultArtifactExclusions();
129 public List<String> getIncludes()
131 return this.includes;
134 public void beginScan( ManagedRepositoryConfiguration repo, Date whenGathered )
135 throws ConsumerException
137 repoId = repo.getId();
138 this.whenGathered = whenGathered;
141 public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
142 throws ConsumerException
144 beginScan( repository, whenGathered );
147 public void processFile( String path )
148 throws ConsumerException
150 // note that we do minimal processing including checksums and POM information for performance of
151 // the initial scan. Any request for this information will be intercepted and populated on-demand
152 // or picked up by subsequent scans
154 ArtifactMetadata artifact = repositoryStorage.readArtifactMetadataFromPath( repoId, path );
156 ProjectMetadata project = new ProjectMetadata();
157 project.setNamespace( artifact.getNamespace() );
158 project.setId( artifact.getProject() );
160 String projectVersion = VersionUtil.getBaseVersion( artifact.getVersion() );
162 RepositorySession repositorySession = repositorySessionFactory.createSession();
165 MetadataRepository metadataRepository = repositorySession.getRepository();
167 boolean createVersionMetadata = false;
169 // FIXME: maybe not too efficient since it may have already been read and stored for this artifact
170 ProjectVersionMetadata versionMetadata = null;
173 versionMetadata = repositoryStorage.readProjectVersionMetadata( repoId, artifact.getNamespace(),
174 artifact.getProject(), projectVersion );
175 createVersionMetadata = true;
177 catch ( RepositoryStorageMetadataNotFoundException e )
179 log.warn( "Missing or invalid POM for artifact: " + path + "; creating empty metadata" );
181 versionMetadata = new ProjectVersionMetadata();
182 versionMetadata.setId( projectVersion );
183 versionMetadata.setIncomplete( true );
184 createVersionMetadata = true;
186 catch ( RepositoryStorageMetadataInvalidException e )
188 log.warn( "Error occurred resolving POM for artifact: " + path + "; message: " + e.getMessage() );
191 // read the metadata and update it if it is newer or doesn't exist
192 artifact.setWhenGathered( whenGathered );
193 metadataRepository.updateArtifact( repoId, project.getNamespace(), project.getId(), projectVersion,
195 if ( createVersionMetadata )
197 metadataRepository.updateProjectVersion( repoId, project.getNamespace(), project.getId(),
200 metadataRepository.updateProject( repoId, project );
201 repositorySession.save();
203 catch ( MetadataRepositoryException e )
205 log.warn( "Error occurred persisting metadata for artifact: " + path + "; message: " + e.getMessage(), e );
206 repositorySession.revert();
210 repositorySession.close();
214 public void processFile( String path, boolean executeOnEntireRepo )
215 throws ConsumerException
220 public void completeScan()
225 public void completeScan( boolean executeOnEntireRepo )
230 public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
232 if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
238 public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
243 private void initIncludes()
247 includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
251 public void initialize()
253 configuration.addChangeListener( this );