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

   1 package $package;
   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.configuration.ArchivaConfiguration;
  23 import org.apache.archiva.configuration.FileTypes;
  24 import org.apache.archiva.consumers.AbstractMonitoredConsumer;
  25 import org.apache.archiva.consumers.ConsumerException;
  26 import org.apache.archiva.consumers.KnownRepositoryContentConsumer;
  27 import org.apache.archiva.metadata.repository.MetadataResolutionException;
  28 import org.apache.archiva.metadata.repository.MetadataRepositoryException;
  29 import org.apache.archiva.metadata.repository.RepositorySession;
  30 import org.apache.archiva.metadata.repository.RepositorySessionFactory;
  31 import org.apache.archiva.model.ArtifactReference;
  32 import org.apache.archiva.components.registry.Registry;
  33 import org.apache.archiva.components.registry.RegistryListener;
  34 import org.apache.archiva.repository.ManagedRepositoryContent;
  35 import org.apache.archiva.repository.LayoutException;
  36 import org.apache.archiva.repository.ManagedRepository;
  37 import org.apache.archiva.repository.BaseRepositoryContentLayout;
  38 import org.apache.archiva.repository.RepositoryContentFactory;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import org.springframework.context.annotation.Scope;
  42 import org.springframework.stereotype.Service;
  43
  44 import javax.annotation.PostConstruct;
  45 import javax.inject.Inject;
  46 import javax.inject.Named;
  47 import java.util.ArrayList;
  48 import java.util.Date;
  49 import java.util.List;
  50
  51 /**
  52  * <code>SimpleArtifactConsumer</code>
  53  *
  54  */
  55 @Service("knownRepositoryContentConsumer#simple")
  56 @Scope("prototype")
  57 public class SimpleArtifactConsumer
  58     extends AbstractMonitoredConsumer
  59     implements KnownRepositoryContentConsumer, RegistryListener
  60 {
  61
  62     private Logger log = LoggerFactory.getLogger( SimpleArtifactConsumer.class );
  63
  64     /**
  65      * default-value="simple-artifact-consumer"
  66      */
  67     private String id = "simple-artifact-consumer";
  68
  69     private String description = "Simple consumer to illustrate how to consume the contents of a repository.";
  70
  71     @Inject
  72     private FileTypes filetypes;
  73
  74     @Inject
  75     private ArchivaConfiguration configuration;
  76
  77     private List<String> propertyNameTriggers = new ArrayList<>();
  78
  79     private List<String> includes = new ArrayList<>();
  80
  81     /** current repository being scanned */
  82     private ManagedRepository repository;
  83
  84     @Inject
  85     @Named( value = "repositoryContentFactory#default" )
  86     private RepositoryContentFactory repositoryContentFactory;
  87
  88     @Inject
  89     private RepositorySessionFactory repositorySessionFactory;
  90
  91     private RepositorySession repositorySession;
  92
  93     public void beginScan( ManagedRepository repository, Date whenGathered )
  94         throws ConsumerException
  95     {
  96         beginScan( repository, whenGathered, true );
  97     }
  98
  99     public void beginScan( ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo )
 100         throws ConsumerException
 101     {
 102         this.repository = repository;
 103         log.info( "Beginning scan of repository [{}]", this.repository.getId() );
 104
 105         try
 106         {
 107             repositorySession = repositorySessionFactory.createSession( );
 108         } catch (MetadataRepositoryException e) {
 109             log.error("Could not create repository session {}", e.getMessage());
 110             throw new ConsumerException( "Could not create repository session: " + e.getMessage( ), e );
 111         }
 112     }
 113
 114     public void processFile( String path )
 115         throws ConsumerException
 116     {
 117         processFile( path, true );
 118     }
 119
 120     public void processFile( String path, boolean executeOnEntireRepo )
 121         throws ConsumerException
 122     {
 123         log.info( "Processing entry [{}] from repository [{}]", path, this.repository.getId() );
 124
 125         try
 126         {
 127             ManagedRepositoryContent repositoryContent = repository.getContent();
 128             BaseRepositoryContentLayout layout = repositoryContent.getLayout( BaseRepositoryContentLayout.class );
 129             ArtifactReference artifact = layout.toArtifactReference( path );
 130
 131             repositorySession.getRepository().getArtifacts( repositorySession, repository.getId(), artifact.getGroupId(),
 132                                                             artifact.getArtifactId(), artifact.getVersion() );
 133         }
 134         catch ( LayoutException | MetadataResolutionException  e )
 135         {
 136             throw new ConsumerException( e.getLocalizedMessage(), e );
 137         }
 138     }
 139
 140     public void completeScan()
 141     {
 142         completeScan( true );
 143     }
 144
 145     public void completeScan( boolean executeOnEntireRepo )
 146     {
 147         log.info( "Finished scan of repository [" + this.repository.getId() + "]" );
 148
 149         repositorySession.close();
 150     }
 151
 152
 153     /**
 154      * Used by archiva to determine if the consumer wishes to process all of a repository's entries or just those that
 155      * have been modified since the last scan.
 156      *
 157      * @return boolean true if the consumer wishes to process all entries on each scan, false for only those modified
 158      *         since the last scan
 159      */
 160     public boolean isProcessUnmodified()
 161     {
 162         return super.isProcessUnmodified();
 163     }
 164
 165     public void afterConfigurationChange( org.apache.archiva.components.registry.Registry registry, String propertyName, Object propertyValue )
 166     {
 167         if ( propertyNameTriggers.contains( propertyName ) )
 168         {
 169             initIncludes();
 170         }
 171     }
 172
 173     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 174     {
 175         /* do nothing */
 176     }
 177
 178     private void initIncludes()
 179     {
 180         includes.clear();
 181         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 182     }
 183
 184     @PostConstruct
 185     public void initialize()
 186     {
 187         propertyNameTriggers = new ArrayList<>();
 188         propertyNameTriggers.add( "repositoryScanning" );
 189         propertyNameTriggers.add( "fileTypes" );
 190         propertyNameTriggers.add( "fileType" );
 191         propertyNameTriggers.add( "patterns" );
 192         propertyNameTriggers.add( "pattern" );
 193
 194         configuration.addChangeListener( this );
 195
 196         initIncludes();
 197     }
 198
 199     public String getId()
 200     {
 201         return this.id;
 202     }
 203
 204     public String getDescription()
 205     {
 206         return this.description;
 207     }
 208
 209     public List<String> getExcludes()
 210     {
 211         return null;
 212     }
 213
 214     public List<String> getIncludes()
 215     {
 216         return this.includes;
 217     }
 218
 219     public boolean isPermanent()
 220     {
 221         return false;
 222     }
 223 }