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
  90      *
  91      * @plexus.requirement role-hint="maven2"
  92      */
  93     private RepositoryStorage repositoryStorage;
  94
  95     private static final Logger log = LoggerFactory.getLogger( ArchivaMetadataCreationConsumer.class );
  96
  97     private String repoId;
  98
  99     public String getId()
 100     {
 101         return this.id;
 102     }
 103
 104     public String getDescription()
 105     {
 106         return this.description;
 107     }
 108
 109     public boolean isPermanent()
 110     {
 111         return true;
 112     }
 113
 114     public List<String> getExcludes()
 115     {
 116         return getDefaultArtifactExclusions();
 117     }
 118
 119     public List<String> getIncludes()
 120     {
 121         return this.includes;
 122     }
 123
 124     public void beginScan( ManagedRepositoryConfiguration repo, Date whenGathered )
 125         throws ConsumerException
 126     {
 127         repoId = repo.getId();
 128         this.whenGathered = whenGathered;
 129     }
 130
 131     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 132         throws ConsumerException
 133     {
 134         beginScan( repository, whenGathered );
 135     }
 136
 137     public void processFile( String path )
 138         throws ConsumerException
 139     {
 140         // note that we do minimal processing including checksums and POM information for performance of
 141         // the initial scan. Any request for this information will be intercepted and populated on-demand
 142         // or picked up by subsequent scans
 143
 144         ArtifactMetadata artifact = repositoryStorage.readArtifactMetadataFromPath( repoId, path );
 145
 146         ProjectMetadata project = new ProjectMetadata();
 147         project.setNamespace( artifact.getNamespace() );
 148         project.setId( artifact.getProject() );
 149
 150         String projectVersion = VersionUtil.getBaseVersion( artifact.getVersion() );
 151         // TODO: maybe not too efficient since it may have already been read and stored for this artifact
 152         ProjectVersionMetadata versionMetadata = null;
 153         try
 154         {
 155             versionMetadata = repositoryStorage.readProjectVersionMetadata( repoId, artifact.getNamespace(),
 156                                                                             artifact.getProject(), projectVersion );
 157         }
 158         catch ( MetadataResolutionException e )
 159         {
 160             log.warn( "Error occurred resolving POM for artifact: " + path + "; message: " + e.getMessage() );
 161         }
 162
 163         boolean createVersionMetadata = false;
 164         if ( versionMetadata == null )
 165         {
 166             log.warn( "Missing or invalid POM for artifact: " + path + "; creating empty metadata" );
 167             versionMetadata = new ProjectVersionMetadata();
 168             versionMetadata.setId( projectVersion );
 169             versionMetadata.setIncomplete( true );
 170             createVersionMetadata = true;
 171         }
 172
 173         try
 174         {
 175             // TODO: transaction
 176             // read the metadata and update it if it is newer or doesn't exist
 177             artifact.setWhenGathered( whenGathered );
 178             metadataRepository.updateArtifact( repoId, project.getNamespace(), project.getId(), projectVersion,
 179                                                artifact );
 180             if ( createVersionMetadata )
 181             {
 182                 metadataRepository.updateProjectVersion( repoId, project.getNamespace(), project.getId(),
 183                                                          versionMetadata );
 184             }
 185             metadataRepository.updateProject( repoId, project );
 186         }
 187         catch ( MetadataRepositoryException e )
 188         {
 189             log.warn( "Error occurred persisting metadata for artifact: " + path + "; message: " + e.getMessage(), e );
 190         }
 191     }
 192
 193     public void processFile( String path, boolean executeOnEntireRepo )
 194         throws ConsumerException
 195     {
 196         processFile( path );
 197     }
 198
 199     public void completeScan()
 200     {
 201         /* do nothing */
 202     }
 203
 204     public void completeScan( boolean executeOnEntireRepo )
 205     {
 206         completeScan();
 207     }
 208
 209     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 210     {
 211         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 212         {
 213             initIncludes();
 214         }
 215     }
 216
 217     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 218     {
 219         /* do nothing */
 220     }
 221
 222     private void initIncludes()
 223     {
 224         includes.clear();
 225
 226         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 227     }
 228
 229     public void initialize()
 230         throws InitializationException
 231     {
 232         configuration.addChangeListener( this );
 233
 234         initIncludes();
 235     }
 236 }