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

   1 package org.apache.maven.repository.discovery;
   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
  22 import java.util.Iterator;
  23 import java.util.List;
  24
  25 /**
  26  * Interface for implementation that can discover artifacts within a repository.
  27  *
  28  * @author John Casey
  29  * @author Brett Porter
  30  */
  31 public interface ArtifactDiscoverer
  32 {
  33     String ROLE = ArtifactDiscoverer.class.getName();
  34
  35     /**
  36      * Discover artifacts in the repository.
  37      *
  38      * @param repository          the location of the repository
  39      * @param blacklistedPatterns pattern that lists any files to prevent from being included when scanning
  40      * @param includeSnapshots    whether to discover snapshots
  41      * @return the list of artifacts discovered
  42      * @todo do we want blacklisted patterns in another form? Part of the object construction?
  43      * @todo should includeSnapshots be configuration on the component?
  44      * @todo instead of a returned list, should a listener be passed in?
  45      */
  46     List discoverArtifacts( ArtifactRepository repository, String blacklistedPatterns, boolean includeSnapshots );
  47
  48     /**
  49      * Discover standalone POM artifacts in the repository.
  50      *
  51      * @param repository          the location of the repository
  52      * @param blacklistedPatterns pattern that lists any files to prevent from being included when scanning
  53      * @param includeSnapshots    whether to discover snapshots
  54      * @return the list of artifacts discovered
  55      * @todo do we want blacklisted patterns in another form? Part of the object construction?
  56      * @todo should includeSnapshots be configuration on the component?
  57      * @todo instead of a returned list, should a listener be passed in?
  58      */
  59     List discoverStandalonePoms( ArtifactRepository repository, String blacklistedPatterns, boolean includeSnapshots );
  60
  61     /**
  62      * Get the list of paths kicked out during the discovery process.
  63      *
  64      * @return the paths as Strings.
  65      */
  66     Iterator getKickedOutPathsIterator();
  67
  68     /**
  69      * Get the list of paths excluded during the discovery process.
  70      *
  71      * @return the paths as Strings.
  72      */
  73     Iterator getExcludedPathsIterator();
  74
  75     /**
  76      * Build an artifact from a path in the repository
  77      *
  78      * @param path the path
  79      * @return the artifact
  80      * @todo this should be in maven-artifact
  81      */
  82     Artifact buildArtifact( String path );
  83 }