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