source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.consumers.metadata;
   2
   3 /*
   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
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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
  19  * under the License.
  20  */
  21
  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.MetadataResolutionException;
  28 import org.apache.archiva.metadata.repository.storage.RepositoryStorage;
  29 import org.apache.maven.archiva.common.utils.VersionUtil;
  30 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  31 import org.apache.maven.archiva.configuration.ConfigurationNames;
  32 import org.apache.maven.archiva.configuration.FileTypes;
  33 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  34 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  35 import org.apache.maven.archiva.consumers.ConsumerException;
  36 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  37 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  38 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  39 import org.codehaus.plexus.registry.Registry;
  40 import org.codehaus.plexus.registry.RegistryListener;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 import java.util.ArrayList;
  45 import java.util.Date;
  46 import java.util.List;
  47
  48 /**
  49  * Take an artifact off of disk and put it into the metadata repository.
  50  *
  51  * @version $Id: ArtifactUpdateDatabaseConsumer.java 718864 2008-11-19 06:33:35Z brett $
  52  * @plexus.component role="org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer"
  53  * role-hint="create-archiva-metadata" instantiation-strategy="per-lookup"
  54  */
  55 public class ArchivaMetadataCreationConsumer
  56     extends AbstractMonitoredConsumer
  57     implements KnownRepositoryContentConsumer, RegistryListener, Initializable
  58 {
  59     /**
  60      * @plexus.configuration default-value="create-archiva-metadata"
  61      */
  62     private String id;
  63
  64     /**
  65      * @plexus.configuration default-value="Create basic metadata for Archiva to be able to reference the artifact"
  66      */
  67     private String description;
  68
  69     /**
  70      * @plexus.requirement
  71      */
  72     private ArchivaConfiguration configuration;
  73
  74     /**
  75      * @plexus.requirement
  76      */
  77     private FileTypes filetypes;
  78
  79     private Date whenGathered;
  80
  81     private List<String> includes = new ArrayList<String>();
  82
  83     /**
  84      * @plexus.requirement
  85      */
  86     private MetadataRepository metadataRepository;
  87
  88     /**
  89      * FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo. Change to a
  90      * factory.
  91      *
  92      * @plexus.requirement role-hint="maven2"
  93      */
  94     private RepositoryStorage repositoryStorage;
  95
  96     private static final Logger log = LoggerFactory.getLogger( ArchivaMetadataCreationConsumer.class );
  97
  98     private String repoId;
  99
 100     public String getId()
 101     {
 102         return this.id;
 103     }
 104
 105     public String getDescription()
 106     {
 107         return this.description;
 108     }
 109
 110     public boolean isPermanent()
 111     {
 112         return true;
 113     }
 114
 115     public List<String> getExcludes()
 116     {
 117         return getDefaultArtifactExclusions();
 118     }
 119
 120     public List<String> getIncludes()
 121     {
 122         return this.includes;
 123     }
 124
 125     public void beginScan( ManagedRepositoryConfiguration repo, Date whenGathered )
 126         throws ConsumerException
 127     {
 128         repoId = repo.getId();
 129         this.whenGathered = whenGathered;
 130     }
 131
 132     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 133         throws ConsumerException
 134     {
 135         beginScan( repository, whenGathered );
 136     }
 137
 138     public void processFile( String path )
 139         throws ConsumerException
 140     {
 141         // note that we do minimal processing including checksums and POM information for performance of
 142         // the initial scan. Any request for this information will be intercepted and populated on-demand
 143         // or picked up by subsequent scans
 144
 145         ArtifactMetadata artifact = repositoryStorage.readArtifactMetadataFromPath( repoId, path );
 146
 147         ProjectMetadata project = new ProjectMetadata();
 148         project.setNamespace( artifact.getNamespace() );
 149         project.setId( artifact.getProject() );
 150
 151         String projectVersion = VersionUtil.getBaseVersion( artifact.getVersion() );
 152         // FIXME: maybe not too efficient since it may have already been read and stored for this artifact
 153         ProjectVersionMetadata versionMetadata = null;
 154         try
 155         {
 156             versionMetadata = repositoryStorage.readProjectVersionMetadata( repoId, artifact.getNamespace(),
 157                                                                             artifact.getProject(), projectVersion );
 158         }
 159         catch ( MetadataResolutionException e )
 160         {
 161             log.warn( "Error occurred resolving POM for artifact: " + path + "; message: " + e.getMessage() );
 162         }
 163
 164         boolean createVersionMetadata = false;
 165         if ( versionMetadata == null )
 166         {
 167             log.warn( "Missing or invalid POM for artifact: " + path + "; creating empty metadata" );
 168             versionMetadata = new ProjectVersionMetadata();
 169             versionMetadata.setId( projectVersion );
 170             versionMetadata.setIncomplete( true );
 171             createVersionMetadata = true;
 172         }
 173
 174         try
 175         {
 176             // FIXME: transaction
 177             // read the metadata and update it if it is newer or doesn't exist
 178             artifact.setWhenGathered( whenGathered );
 179             metadataRepository.updateArtifact( repoId, project.getNamespace(), project.getId(), projectVersion,
 180                                                artifact );
 181             if ( createVersionMetadata )
 182             {
 183                 metadataRepository.updateProjectVersion( repoId, project.getNamespace(), project.getId(),
 184                                                          versionMetadata );
 185             }
 186             metadataRepository.updateProject( repoId, project );
 187         }
 188         catch ( MetadataRepositoryException e )
 189         {
 190             log.warn( "Error occurred persisting metadata for artifact: " + path + "; message: " + e.getMessage(), e );
 191         }
 192     }
 193
 194     public void processFile( String path, boolean executeOnEntireRepo )
 195         throws ConsumerException
 196     {
 197         processFile( path );
 198     }
 199
 200     public void completeScan()
 201     {
 202         /* do nothing */
 203     }
 204
 205     public void completeScan( boolean executeOnEntireRepo )
 206     {
 207         completeScan();
 208     }
 209
 210     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 211     {
 212         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 213         {
 214             initIncludes();
 215         }
 216     }
 217
 218     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 219     {
 220         /* do nothing */
 221     }
 222
 223     private void initIncludes()
 224     {
 225         includes.clear();
 226
 227         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 228     }
 229
 230     public void initialize()
 231         throws InitializationException
 232     {
 233         configuration.addChangeListener( this );
 234
 235         initIncludes();
 236     }
 237 }