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