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

   1 package org.apache.maven.archiva.discoverer;
   2
   3 /*
   4  * Copyright 2005-2006 The Apache Software Foundation.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import org.apache.maven.artifact.Artifact;
  20 import org.apache.maven.artifact.repository.ArtifactRepository;
  21 import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
  22
  23 import java.io.File;
  24 import java.util.ArrayList;
  25 import java.util.Iterator;
  26 import java.util.List;
  27
  28 /**
  29  * Base class for artifact discoverers.
  30  *
  31  * @author John Casey
  32  * @author Brett Porter
  33  */
  34 public abstract class AbstractArtifactDiscoverer
  35     extends AbstractDiscoverer
  36     implements ArtifactDiscoverer
  37 {
  38     /**
  39      * Standard patterns to exclude from discovery as they are not artifacts.
  40      */
  41     private static final String[] STANDARD_DISCOVERY_EXCLUDES = {"bin/**", "reports/**", ".index", ".reports/**",
  42         ".maven/**", "**/*.md5", "**/*.MD5", "**/*.sha1", "**/*.SHA1", "**/*snapshot-version", "*/website/**",
  43         "*/licenses/**", "*/licences/**", "**/.htaccess", "**/*.html", "**/*.asc", "**/*.txt", "**/*.xml", "**/README*",
  44         "**/CHANGELOG*", "**/KEYS*"};
  45
  46     private List scanForArtifactPaths( File repositoryBase, List blacklistedPatterns )
  47     {
  48         return scanForArtifactPaths( repositoryBase, blacklistedPatterns, null, STANDARD_DISCOVERY_EXCLUDES );
  49     }
  50
  51     public List discoverArtifacts( ArtifactRepository repository, List blacklistedPatterns, ArtifactFilter filter )
  52         throws DiscovererException
  53     {
  54         if ( !"file".equals( repository.getProtocol() ) )
  55         {
  56             throw new UnsupportedOperationException( "Only filesystem repositories are supported" );
  57         }
  58
  59         File repositoryBase = new File( repository.getBasedir() );
  60
  61         List artifacts = new ArrayList();
  62
  63         List artifactPaths = scanForArtifactPaths( repositoryBase, blacklistedPatterns );
  64
  65         for ( Iterator i = artifactPaths.iterator(); i.hasNext(); )
  66         {
  67             String path = (String) i.next();
  68
  69             try
  70             {
  71                 Artifact artifact = buildArtifactFromPath( path, repository );
  72
  73                 if ( filter.include( artifact ) )
  74                 {
  75                     artifacts.add( artifact );
  76                 }
  77                 else
  78                 {
  79                     addExcludedPath( path, "Omitted by filter" );
  80                 }
  81             }
  82             catch ( DiscovererException e )
  83             {
  84                 addKickedOutPath( path, e.getMessage() );
  85             }
  86         }
  87
  88         return artifacts;
  89     }
  90
  91 /**
  92  * Returns an artifact object that is represented by the specified path in a repository
  93      *
  94      * @param path       The path that is pointing to an artifact
  95      * @param repository The repository of the artifact
  96      * @return Artifact
  97      * @throws DiscovererException when the specified path does correspond to an artifact
  98      */
  99     public Artifact buildArtifactFromPath( String path, ArtifactRepository repository )
 100         throws DiscovererException
 101     {
 102         Artifact artifact = buildArtifact( path );
 103
 104         if ( artifact != null )
 105         {
 106             artifact.setRepository( repository );
 107             artifact.setFile( new File( repository.getBasedir(), path ) );
 108         }
 109
 110         return artifact;
 111     }
 112 }