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.repository.events.RepositoryListener;
  23 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  24 import org.apache.maven.archiva.configuration.ConfigurationNames;
  25 import org.apache.maven.archiva.configuration.FileTypes;
  26 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  27 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  28 import org.apache.maven.archiva.consumers.ConsumerException;
  29 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  30 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  31 import org.apache.maven.archiva.repository.RepositoryContentFactory;
  32 import org.apache.maven.archiva.repository.RepositoryException;
  33 import org.apache.maven.archiva.repository.RepositoryNotFoundException;
  34 import org.apache.maven.archiva.repository.metadata.MetadataTools;
  35 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  36 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  37 import org.codehaus.plexus.registry.Registry;
  38 import org.codehaus.plexus.registry.RegistryListener;
  39
  40 import java.util.ArrayList;
  41 import java.util.Collections;
  42 import java.util.Date;
  43 import java.util.List;
  44
  45 /**
  46  * Consumer for removing old snapshots in the repository based on the criteria
  47  * specified by the user.
  48  *
  49  *
  50  * @plexus.component
  51  *      role="org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer"
  52  *      role-hint="repository-purge"
  53  *      instantiation-strategy="per-lookup"
  54  */
  55 public class RepositoryPurgeConsumer
  56     extends AbstractMonitoredConsumer
  57     implements KnownRepositoryContentConsumer, RegistryListener, Initializable
  58 {
  59     /**
  60      * @plexus.configuration default-value="repository-purge"
  61      */
  62     private String id;
  63
  64     /**
  65      * @plexus.configuration default-value="Purge repository of old snapshots"
  66      */
  67     private String description;
  68
  69     /**
  70      * @plexus.requirement
  71      */
  72     private ArchivaConfiguration configuration;
  73
  74     /**
  75      * @plexus.requirement
  76      */
  77     private RepositoryContentFactory repositoryFactory;
  78
  79     /**
  80      * @plexus.requirement
  81      */
  82     private MetadataTools metadataTools;
  83
  84     /**
  85      * @plexus.requirement
  86      */
  87     private FileTypes filetypes;
  88
  89     private List<String> includes = new ArrayList<String>();
  90
  91     private RepositoryPurge repoPurge;
  92
  93     private RepositoryPurge cleanUp;
  94
  95     private boolean deleteReleasedSnapshots;
  96
  97     /** @plexus.requirement role="org.apache.archiva.repository.events.RepositoryListener" */
  98     private List<RepositoryListener> listeners = Collections.emptyList();
  99
 100     public String getId()
 101     {
 102         return this.id;
 103     }
 104
 105     public String getDescription()
 106     {
 107         return this.description;
 108     }
 109
 110     public boolean isPermanent()
 111     {
 112         return false;
 113     }
 114
 115     public List<String> getExcludes()
 116     {
 117         return getDefaultArtifactExclusions();
 118     }
 119
 120     public List<String> getIncludes()
 121     {
 122         return this.includes;
 123     }
 124
 125     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered )
 126         throws ConsumerException
 127     {
 128         try
 129         {
 130             ManagedRepositoryContent repositoryContent = repositoryFactory.getManagedRepositoryContent( repository
 131                 .getId() );
 132
 133             if ( repository.getDaysOlder() != 0 )
 134             {
 135                 repoPurge = new DaysOldRepositoryPurge( repositoryContent, repository.getDaysOlder(),
 136                                                         repository.getRetentionCount(), listeners );
 137             }
 138             else
 139             {
 140                 repoPurge = new RetentionCountRepositoryPurge( repositoryContent, repository.getRetentionCount(),
 141                                                                listeners );
 142             }
 143
 144             cleanUp =
 145                 new CleanupReleasedSnapshotsRepositoryPurge( repositoryContent, metadataTools, configuration,
 146                                                              repositoryFactory, listeners );
 147
 148             deleteReleasedSnapshots = repository.isDeleteReleasedSnapshots();
 149         }
 150         catch ( RepositoryNotFoundException e )
 151         {
 152             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 153         }
 154         catch ( RepositoryException e )
 155         {
 156             throw new ConsumerException( "Can't run repository purge: " + e.getMessage(), e );
 157         }
 158     }
 159
 160     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 161         throws ConsumerException
 162     {
 163         beginScan( repository, whenGathered );
 164     }
 165
 166     public void processFile( String path )
 167         throws ConsumerException
 168     {
 169         try
 170         {
 171             if ( deleteReleasedSnapshots )
 172             {
 173                 cleanUp.process( path );
 174             }
 175
 176             repoPurge.process( path );
 177         }
 178         catch ( RepositoryPurgeException rpe )
 179         {
 180             throw new ConsumerException( rpe.getMessage(), rpe );
 181         }
 182     }
 183
 184     public void processFile( String path, boolean executeOnEntireRepo )
 185         throws Exception
 186     {
 187         processFile( path );
 188     }
 189
 190     public void completeScan()
 191     {
 192         /* do nothing */
 193     }
 194
 195     public void completeScan( boolean executeOnEntireRepo )
 196     {
 197         completeScan();
 198     }
 199
 200     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 201     {
 202         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 203         {
 204             initIncludes();
 205         }
 206     }
 207
 208     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 209     {
 210         /* do nothing */
 211     }
 212
 213     private void initIncludes()
 214     {
 215         includes.clear();
 216
 217         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 218     }
 219
 220     public void initialize()
 221         throws InitializationException
 222     {
 223         configuration.addChangeListener( this );
 224
 225         initIncludes();
 226     }
 227
 228     public boolean isProcessUnmodified()
 229     {
 230         // we need to check all files for deletion, especially if not modified
 231         return true;
 232     }
 233 }