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/**", ".maven/**", "**/*.md5",
  42         "**/*.MD5", "**/*.sha1", "**/*.SHA1", "**/*snapshot-version", "*/website/**", "*/licenses/**", "*/licences/**",
  43         "**/.htaccess", "**/*.html", "**/*.asc", "**/*.txt", "**/*.xml", "**/README*", "**/CHANGELOG*", "**/KEYS*"};
  44
  45     private List scanForArtifactPaths( File repositoryBase, List blacklistedPatterns )
  46     {
  47         return scanForArtifactPaths( repositoryBase, blacklistedPatterns, null, STANDARD_DISCOVERY_EXCLUDES );
  48     }
  49
  50     public List discoverArtifacts( ArtifactRepository repository, List blacklistedPatterns, ArtifactFilter filter )
  51         throws DiscovererException
  52     {
  53         if ( !"file".equals( repository.getProtocol() ) )
  54         {
  55             throw new UnsupportedOperationException( "Only filesystem repositories are supported" );
  56         }
  57
  58         File repositoryBase = new File( repository.getBasedir() );
  59
  60         List artifacts = new ArrayList();
  61
  62         List artifactPaths = scanForArtifactPaths( repositoryBase, blacklistedPatterns );
  63
  64         for ( Iterator i = artifactPaths.iterator(); i.hasNext(); )
  65         {
  66             String path = (String) i.next();
  67
  68             try
  69             {
  70                 Artifact artifact = buildArtifactFromPath( path, repository );
  71
  72                 if ( filter.include( artifact ) )
  73                 {
  74                     artifacts.add( artifact );
  75                 }
  76                 else
  77                 {
  78                     addExcludedPath( path, "Omitted by filter" );
  79                 }
  80             }
  81             catch ( DiscovererException e )
  82             {
  83                 addKickedOutPath( path, e.getMessage() );
  84             }
  85         }
  86
  87         return artifacts;
  88     }
  89
  90     /**
  91      * Returns an artifact object that is represented by the specified path in a repository
  92      *
  93      * @param path       The path that is pointing to an artifact
  94      * @param repository The repository of the artifact
  95      * @return Artifact
  96      * @throws DiscovererException when the specified path does correspond to an artifact
  97      */
  98     public Artifact buildArtifactFromPath( String path, ArtifactRepository repository )
  99         throws DiscovererException
 100     {
 101         Artifact artifact = buildArtifact( path );
 102
 103         if ( artifact != null )
 104         {
 105             artifact.setRepository( repository );
 106             artifact.setFile( new File( repository.getBasedir(), path ) );
 107         }
 108
 109         return artifact;
 110     }
 111 }