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      * plexus.requirement
  73      */
  74     @Inject
  75     @Named( value = "archivaConfiguration#default" )
  76     private ArchivaConfiguration configuration;
  77
  78     /**
  79      * plexus.requirement
  80      */
  81     @Inject
  82     @Named(value = "repositoryContentFactory#default")
  83     private RepositoryContentFactory repositoryContentFactory;
  84
  85     /**
  86      * plexus.requirement
  87      */
  88     @Inject
  89     private MetadataTools metadataTools;
  90
  91     /**
  92      * plexus.requirement
  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     //@Inject
 107     //private ApplicationContext applicationContext;
 108
 109     /**
 110      * plexus.requirement role="org.apache.archiva.repository.events.RepositoryListener"
 111      */
 112     @Inject
 113     private List<RepositoryListener> listeners = Collections.emptyList();
 114
 115     /**
 116      * TODO: this could be multiple implementations and needs to be configured.
 117      * <p/>
 118      * plexus.requirement
 119      */
 120     @Inject
 121     private RepositorySessionFactory repositorySessionFactory;
 122
 123     private RepositorySession repositorySession;
 124
 125     public String getId()
 126     {
 127         return this.id;
 128     }
 129
 130     public String getDescription()
 131     {
 132         return this.description;
 133     }
 134
 135     public boolean isPermanent()
 136     {
 137         return false;
 138     }
 139
 140     public List<String> getExcludes()
 141     {
 142         return getDefaultArtifactExclusions();
 143     }
 144
 145     public List<String> getIncludes()
 146     {
 147         return this.includes;
 148     }
 149
 150     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered )
 151         throws ConsumerException
 152     {
 153         ManagedRepositoryContent repositoryContent;
 154         try
 155         {
 156             repositoryContent = repositoryContentFactory.getManagedRepositoryContent( repository.getId() );
 157         }
 158         catch ( RepositoryNotFoundException e )
 159         {
 160             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 161         }
 162         catch ( RepositoryException e )
 163         {
 164             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 165         }
 166
 167         repositorySession = repositorySessionFactory.createSession();
 168
 169         if ( repository.getDaysOlder() != 0 )
 170         {
 171             repoPurge = new DaysOldRepositoryPurge( repositoryContent, repository.getDaysOlder(),
 172                                                     repository.getRetentionCount(), repositorySession, listeners );
 173         }
 174         else
 175         {
 176             repoPurge =
 177                 new RetentionCountRepositoryPurge( repositoryContent, repository.getRetentionCount(), repositorySession,
 178                                                    listeners );
 179         }
 180
 181         cleanUp = new CleanupReleasedSnapshotsRepositoryPurge( repositoryContent, metadataTools, configuration,
 182                                                                repositoryContentFactory, repositorySession, listeners );
 183
 184         deleteReleasedSnapshots = repository.isDeleteReleasedSnapshots();
 185     }
 186
 187     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 188         throws ConsumerException
 189     {
 190         beginScan( repository, whenGathered );
 191     }
 192
 193     public void processFile( String path )
 194         throws ConsumerException
 195     {
 196         try
 197         {
 198             if ( deleteReleasedSnapshots )
 199             {
 200                 cleanUp.process( path );
 201             }
 202
 203             repoPurge.process( path );
 204         }
 205         catch ( RepositoryPurgeException rpe )
 206         {
 207             throw new ConsumerException( rpe.getMessage(), rpe );
 208         }
 209     }
 210
 211     public void processFile( String path, boolean executeOnEntireRepo )
 212         throws Exception
 213     {
 214         processFile( path );
 215     }
 216
 217     public void completeScan()
 218     {
 219         repositorySession.close();
 220     }
 221
 222     public void completeScan( boolean executeOnEntireRepo )
 223     {
 224         completeScan();
 225     }
 226
 227     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 228     {
 229         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 230         {
 231             initIncludes();
 232         }
 233     }
 234
 235     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 236     {
 237         /* do nothing */
 238     }
 239
 240     private void initIncludes()
 241     {
 242         includes.clear();
 243
 244         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 245     }
 246
 247     @PostConstruct
 248     public void initialize()
 249     {
 250         //this.listeners =
 251         //    new ArrayList<RepositoryListener>( applicationContext.getBeansOfType( RepositoryListener.class ).values() );
 252         configuration.addChangeListener( this );
 253
 254         initIncludes();
 255     }
 256
 257     public boolean isProcessUnmodified()
 258     {
 259         // we need to check all files for deletion, especially if not modified
 260         return true;
 261     }
 262
 263     public ArchivaConfiguration getConfiguration()
 264     {
 265         return configuration;
 266     }
 267
 268     public void setConfiguration( ArchivaConfiguration configuration )
 269     {
 270         this.configuration = configuration;
 271     }
 272
 273     public RepositoryContentFactory getRepositoryContentFactory()
 274     {
 275         return repositoryContentFactory;
 276     }
 277
 278     public void setRepositoryContentFactory( RepositoryContentFactory repositoryContentFactory )
 279     {
 280         this.repositoryContentFactory = repositoryContentFactory;
 281     }
 282
 283     public MetadataTools getMetadataTools()
 284     {
 285         return metadataTools;
 286     }
 287
 288     public void setMetadataTools( MetadataTools metadataTools )
 289     {
 290         this.metadataTools = metadataTools;
 291     }
 292
 293     public FileTypes getFiletypes()
 294     {
 295         return filetypes;
 296     }
 297
 298     public void setFiletypes( FileTypes filetypes )
 299     {
 300         this.filetypes = filetypes;
 301     }
 302
 303     public RepositoryPurge getRepoPurge()
 304     {
 305         return repoPurge;
 306     }
 307
 308     public void setRepoPurge( RepositoryPurge repoPurge )
 309     {
 310         this.repoPurge = repoPurge;
 311     }
 312
 313     public RepositoryPurge getCleanUp()
 314     {
 315         return cleanUp;
 316     }
 317
 318     public void setCleanUp( RepositoryPurge cleanUp )
 319     {
 320         this.cleanUp = cleanUp;
 321     }
 322
 323     public boolean isDeleteReleasedSnapshots()
 324     {
 325         return deleteReleasedSnapshots;
 326     }
 327
 328     public void setDeleteReleasedSnapshots( boolean deleteReleasedSnapshots )
 329     {
 330         this.deleteReleasedSnapshots = deleteReleasedSnapshots;
 331     }
 332
 333     public RepositorySessionFactory getRepositorySessionFactory()
 334     {
 335         return repositorySessionFactory;
 336     }
 337
 338     public void setRepositorySessionFactory( RepositorySessionFactory repositorySessionFactory )
 339     {
 340         this.repositorySessionFactory = repositorySessionFactory;
 341     }
 342
 343     public RepositorySession getRepositorySession()
 344     {
 345         return repositorySession;
 346     }
 347
 348     public void setRepositorySession( RepositorySession repositorySession )
 349     {
 350         this.repositorySession = repositorySession;
 351     }
 352 }