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