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

   1 package org.apache.archiva.consumers.lucene;
   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.managed.ManagedRepository;
  23 import org.apache.archiva.common.plexusbridge.MavenIndexerUtils;
  24 import org.apache.archiva.common.plexusbridge.PlexusSisuBridge;
  25 import org.apache.archiva.common.plexusbridge.PlexusSisuBridgeException;
  26 import org.apache.archiva.scheduler.ArchivaTaskScheduler;
  27 import org.apache.archiva.scheduler.indexing.ArtifactIndexingTask;
  28 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  29 import org.apache.maven.archiva.configuration.ConfigurationNames;
  30 import org.apache.maven.archiva.configuration.FileTypes;
  31 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  32 import org.apache.maven.archiva.consumers.ConsumerException;
  33 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  34 import org.apache.maven.index.NexusIndexer;
  35 import org.apache.maven.index.context.IndexCreator;
  36 import org.apache.maven.index.context.IndexingContext;
  37 import org.apache.maven.index.context.UnsupportedExistingLuceneIndexException;
  38 import org.codehaus.plexus.registry.Registry;
  39 import org.codehaus.plexus.registry.RegistryListener;
  40 import org.codehaus.plexus.taskqueue.TaskQueueException;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 import javax.annotation.PostConstruct;
  45 import java.io.File;
  46 import java.io.IOException;
  47 import java.util.ArrayList;
  48 import java.util.Collections;
  49 import java.util.Date;
  50 import java.util.List;
  51
  52 /**
  53  * Consumer for indexing the repository to provide search and IDE integration features.
  54  */
  55 public class NexusIndexerConsumer
  56     extends AbstractMonitoredConsumer
  57     implements KnownRepositoryContentConsumer, RegistryListener
  58 {
  59     private Logger log = LoggerFactory.getLogger( NexusIndexerConsumer.class );
  60
  61     private ArchivaConfiguration configuration;
  62
  63     private FileTypes filetypes;
  64
  65     private File managedRepository;
  66
  67     private ArchivaTaskScheduler<ArtifactIndexingTask> scheduler;
  68
  69     private IndexingContext context;
  70
  71     private NexusIndexer nexusIndexer;
  72
  73     private List<String> includes = new ArrayList<String>();
  74
  75     private ManagedRepository repository;
  76
  77     private List<? extends IndexCreator> allIndexCreators;
  78
  79     public NexusIndexerConsumer( ArchivaTaskScheduler<ArtifactIndexingTask> scheduler,
  80                                  ArchivaConfiguration configuration, FileTypes filetypes,
  81                                  PlexusSisuBridge plexusSisuBridge, MavenIndexerUtils mavenIndexerUtils )
  82         throws PlexusSisuBridgeException
  83     {
  84         this.configuration = configuration;
  85         this.filetypes = filetypes;
  86         this.scheduler = scheduler;
  87         this.nexusIndexer = plexusSisuBridge.lookup( NexusIndexer.class );
  88         this.allIndexCreators = mavenIndexerUtils.getAllIndexCreators();
  89     }
  90
  91     public String getDescription()
  92     {
  93         return "Indexes the repository to provide search and IDE integration features";
  94     }
  95
  96     public String getId()
  97     {
  98         return "index-content";
  99     }
 100
 101     public boolean isPermanent()
 102     {
 103         return false;
 104     }
 105
 106     public void beginScan( ManagedRepository repository, Date whenGathered )
 107         throws ConsumerException
 108     {
 109         this.repository = repository;
 110         managedRepository = new File( repository.getLocation() );
 111
 112         try
 113         {
 114             log.info( "Creating indexing context for repo : {}", repository.getId() );
 115             context = ArtifactIndexingTask.createContext( repository, nexusIndexer, allIndexCreators );
 116         }
 117         catch ( IOException e )
 118         {
 119             throw new ConsumerException( e.getMessage(), e );
 120         }
 121         catch ( UnsupportedExistingLuceneIndexException e )
 122         {
 123             throw new ConsumerException( e.getMessage(), e );
 124         }
 125     }
 126
 127     public void beginScan( ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo )
 128         throws ConsumerException
 129     {
 130         if ( executeOnEntireRepo )
 131         {
 132             beginScan( repository, whenGathered );
 133         }
 134         else
 135         {
 136             this.repository = repository;
 137             managedRepository = new File( repository.getLocation() );
 138         }
 139     }
 140
 141     public void processFile( String path )
 142         throws ConsumerException
 143     {
 144         File artifactFile = new File( managedRepository, path );
 145
 146         ArtifactIndexingTask task =
 147             new ArtifactIndexingTask( repository, artifactFile, ArtifactIndexingTask.Action.ADD, context );
 148         try
 149         {
 150             log.debug( "Queueing indexing task '{}' to add or update the artifact in the index.", task );
 151             scheduler.queueTask( task );
 152         }
 153         catch ( TaskQueueException e )
 154         {
 155             throw new ConsumerException( e.getMessage(), e );
 156         }
 157     }
 158
 159     public void processFile( String path, boolean executeOnEntireRepo )
 160         throws Exception
 161     {
 162         if ( executeOnEntireRepo )
 163         {
 164             processFile( path );
 165         }
 166         else
 167         {
 168             File artifactFile = new File( managedRepository, path );
 169
 170             // specify in indexing task that this is not a repo scan request!
 171             ArtifactIndexingTask task =
 172                 new ArtifactIndexingTask( repository, artifactFile, ArtifactIndexingTask.Action.ADD, context, false );
 173             // only update index we don't need to scan the full repo here
 174             task.setOnlyUpdate( true );
 175             try
 176             {
 177                 log.debug( "Queueing indexing task '{}' to add or update the artifact in the index.", task );
 178                 scheduler.queueTask( task );
 179             }
 180             catch ( TaskQueueException e )
 181             {
 182                 throw new ConsumerException( e.getMessage(), e );
 183             }
 184         }
 185     }
 186
 187     public void completeScan()
 188     {
 189         ArtifactIndexingTask task =
 190             new ArtifactIndexingTask( repository, null, ArtifactIndexingTask.Action.FINISH, context );
 191         try
 192         {
 193             log.debug( "Queueing indexing task '{}' to finish indexing.", task );
 194             scheduler.queueTask( task );
 195         }
 196         catch ( TaskQueueException e )
 197         {
 198             log.error( "Error queueing task: " + task + ": " + e.getMessage(), e );
 199         }
 200         context = null;
 201     }
 202
 203     public void completeScan( boolean executeOnEntireRepo )
 204     {
 205         if ( executeOnEntireRepo )
 206         {
 207             completeScan();
 208         }
 209
 210         // else, do nothing as the context will be closed when indexing task is executed if not a repo scan request!
 211     }
 212
 213     public List<String> getExcludes()
 214     {
 215         return Collections.emptyList();
 216     }
 217
 218     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 219     {
 220         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 221         {
 222             initIncludes();
 223         }
 224     }
 225
 226     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 227     {
 228         /* do nothing */
 229     }
 230
 231     private void initIncludes()
 232     {
 233         includes.clear();
 234
 235         includes.addAll( filetypes.getFileTypePatterns( FileTypes.INDEXABLE_CONTENT ) );
 236
 237         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 238     }
 239
 240     @PostConstruct
 241     public void initialize()
 242     {
 243         configuration.addChangeListener( this );
 244
 245         initIncludes();
 246     }
 247
 248     public List<String> getIncludes()
 249     {
 250         return includes;
 251     }
 252 }