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

   1 package org.apache.maven.archiva.consumers.core.repository;
   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.repository.RepositorySession;
  23 import org.apache.archiva.metadata.repository.RepositorySessionFactory;
  24 import org.apache.archiva.repository.events.RepositoryListener;
  25 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  26 import org.apache.maven.archiva.configuration.ConfigurationNames;
  27 import org.apache.maven.archiva.configuration.FileTypes;
  28 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  29 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  30 import org.apache.maven.archiva.consumers.ConsumerException;
  31 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  32 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  33 import org.apache.maven.archiva.repository.RepositoryContentFactory;
  34 import org.apache.maven.archiva.repository.RepositoryException;
  35 import org.apache.maven.archiva.repository.RepositoryNotFoundException;
  36 import org.apache.maven.archiva.repository.metadata.MetadataTools;
  37 import org.codehaus.plexus.registry.Registry;
  38 import org.codehaus.plexus.registry.RegistryListener;
  39 import org.springframework.context.ApplicationContext;
  40 import org.springframework.context.annotation.Scope;
  41 import org.springframework.stereotype.Service;
  42
  43 import javax.annotation.PostConstruct;
  44 import javax.inject.Inject;
  45 import javax.inject.Named;
  46 import java.util.ArrayList;
  47 import java.util.Collections;
  48 import java.util.Date;
  49 import java.util.List;
  50
  51 /**
  52  * Consumer for removing old snapshots in the repository based on the criteria
  53  * specified by the user.
  54  */
  55 @Service( "knownRepositoryContentConsumer#repository-purge" )
  56 @Scope( "prototype" )
  57 public class RepositoryPurgeConsumer
  58     extends AbstractMonitoredConsumer
  59     implements KnownRepositoryContentConsumer, RegistryListener
  60 {
  61     /**
  62      * plexus.configuration default-value="repository-purge"
  63      */
  64     private String id = "repository-purge";
  65
  66     /**
  67      * plexus.configuration default-value="Purge repository of old snapshots"
  68      */
  69     private String description = "Purge repository of old snapshots";
  70
  71     /**
  72      *
  73      */
  74     @Inject
  75     @Named( value = "archivaConfiguration#default" )
  76     private ArchivaConfiguration configuration;
  77
  78     /**
  79      *
  80      */
  81     @Inject
  82     @Named(value = "repositoryContentFactory#default")
  83     private RepositoryContentFactory repositoryContentFactory;
  84
  85     /**
  86      *
  87      */
  88     @Inject
  89     private MetadataTools metadataTools;
  90
  91     /**
  92      *
  93      */
  94     @Inject
  95     @Named(value = "fileTypes")
  96     private FileTypes filetypes;
  97
  98     private List<String> includes = new ArrayList<String>();
  99
 100     private RepositoryPurge repoPurge;
 101
 102     private RepositoryPurge cleanUp;
 103
 104     private boolean deleteReleasedSnapshots;
 105
 106     /**
 107      *
 108      */
 109     @Inject
 110     private List<RepositoryListener> listeners = Collections.emptyList();
 111
 112     /**
 113      * TODO: this could be multiple implementations and needs to be configured.
 114      *
 115      */
 116     @Inject
 117     private RepositorySessionFactory repositorySessionFactory;
 118
 119     private RepositorySession repositorySession;
 120
 121     public String getId()
 122     {
 123         return this.id;
 124     }
 125
 126     public String getDescription()
 127     {
 128         return this.description;
 129     }
 130
 131     public boolean isPermanent()
 132     {
 133         return false;
 134     }
 135
 136     public List<String> getExcludes()
 137     {
 138         return getDefaultArtifactExclusions();
 139     }
 140
 141     public List<String> getIncludes()
 142     {
 143         return this.includes;
 144     }
 145
 146     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered )
 147         throws ConsumerException
 148     {
 149         ManagedRepositoryContent repositoryContent;
 150         try
 151         {
 152             repositoryContent = repositoryContentFactory.getManagedRepositoryContent( repository.getId() );
 153         }
 154         catch ( RepositoryNotFoundException e )
 155         {
 156             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 157         }
 158         catch ( RepositoryException e )
 159         {
 160             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 161         }
 162
 163         repositorySession = repositorySessionFactory.createSession();
 164
 165         if ( repository.getDaysOlder() != 0 )
 166         {
 167             repoPurge = new DaysOldRepositoryPurge( repositoryContent, repository.getDaysOlder(),
 168                                                     repository.getRetentionCount(), repositorySession, listeners );
 169         }
 170         else
 171         {
 172             repoPurge =
 173                 new RetentionCountRepositoryPurge( repositoryContent, repository.getRetentionCount(), repositorySession,
 174                                                    listeners );
 175         }
 176
 177         cleanUp = new CleanupReleasedSnapshotsRepositoryPurge( repositoryContent, metadataTools, configuration,
 178                                                                repositoryContentFactory, repositorySession, listeners );
 179
 180         deleteReleasedSnapshots = repository.isDeleteReleasedSnapshots();
 181     }
 182
 183     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 184         throws ConsumerException
 185     {
 186         beginScan( repository, whenGathered );
 187     }
 188
 189     public void processFile( String path )
 190         throws ConsumerException
 191     {
 192         try
 193         {
 194             if ( deleteReleasedSnapshots )
 195             {
 196                 cleanUp.process( path );
 197             }
 198
 199             repoPurge.process( path );
 200         }
 201         catch ( RepositoryPurgeException rpe )
 202         {
 203             throw new ConsumerException( rpe.getMessage(), rpe );
 204         }
 205     }
 206
 207     public void processFile( String path, boolean executeOnEntireRepo )
 208         throws Exception
 209     {
 210         processFile( path );
 211     }
 212
 213     public void completeScan()
 214     {
 215         repositorySession.close();
 216     }
 217
 218     public void completeScan( boolean executeOnEntireRepo )
 219     {
 220         completeScan();
 221     }
 222
 223     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 224     {
 225         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 226         {
 227             initIncludes();
 228         }
 229     }
 230
 231     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 232     {
 233         /* do nothing */
 234     }
 235
 236     private void initIncludes()
 237     {
 238         includes.clear();
 239
 240         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 241     }
 242
 243     @PostConstruct
 244     public void initialize()
 245     {
 246         //this.listeners =
 247         //    new ArrayList<RepositoryListener>( applicationContext.getBeansOfType( RepositoryListener.class ).values() );
 248         configuration.addChangeListener( this );
 249
 250         initIncludes();
 251     }
 252
 253     public boolean isProcessUnmodified()
 254     {
 255         // we need to check all files for deletion, especially if not modified
 256         return true;
 257     }
 258
 259     public ArchivaConfiguration getConfiguration()
 260     {
 261         return configuration;
 262     }
 263
 264     public void setConfiguration( ArchivaConfiguration configuration )
 265     {
 266         this.configuration = configuration;
 267     }
 268
 269     public RepositoryContentFactory getRepositoryContentFactory()
 270     {
 271         return repositoryContentFactory;
 272     }
 273
 274     public void setRepositoryContentFactory( RepositoryContentFactory repositoryContentFactory )
 275     {
 276         this.repositoryContentFactory = repositoryContentFactory;
 277     }
 278
 279     public MetadataTools getMetadataTools()
 280     {
 281         return metadataTools;
 282     }
 283
 284     public void setMetadataTools( MetadataTools metadataTools )
 285     {
 286         this.metadataTools = metadataTools;
 287     }
 288
 289     public FileTypes getFiletypes()
 290     {
 291         return filetypes;
 292     }
 293
 294     public void setFiletypes( FileTypes filetypes )
 295     {
 296         this.filetypes = filetypes;
 297     }
 298
 299     public RepositoryPurge getRepoPurge()
 300     {
 301         return repoPurge;
 302     }
 303
 304     public void setRepoPurge( RepositoryPurge repoPurge )
 305     {
 306         this.repoPurge = repoPurge;
 307     }
 308
 309     public RepositoryPurge getCleanUp()
 310     {
 311         return cleanUp;
 312     }
 313
 314     public void setCleanUp( RepositoryPurge cleanUp )
 315     {
 316         this.cleanUp = cleanUp;
 317     }
 318
 319     public boolean isDeleteReleasedSnapshots()
 320     {
 321         return deleteReleasedSnapshots;
 322     }
 323
 324     public void setDeleteReleasedSnapshots( boolean deleteReleasedSnapshots )
 325     {
 326         this.deleteReleasedSnapshots = deleteReleasedSnapshots;
 327     }
 328
 329     public RepositorySessionFactory getRepositorySessionFactory()
 330     {
 331         return repositorySessionFactory;
 332     }
 333
 334     public void setRepositorySessionFactory( RepositorySessionFactory repositorySessionFactory )
 335     {
 336         this.repositorySessionFactory = repositorySessionFactory;
 337     }
 338
 339     public RepositorySession getRepositorySession()
 340     {
 341         return repositorySession;
 342     }
 343
 344     public void setRepositorySession( RepositorySession repositorySession )
 345     {
 346         this.repositorySession = repositorySession;
 347     }
 348 }