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

   1 package org.apache.maven.archiva.indexer.search;
   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 java.util.List;
  23
  24 /**
  25  * Search across repositories in lucene indexes.
  26  *
  27  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  28  * @version $Id$
  29  * @todo add security to not perform search in repositories you don't have access to.
  30  */
  31 public interface CrossRepositorySearch
  32 {
  33     /**
  34      * Search for the specific term across all repositories.
  35      *
  36      * @param term the term to search for.
  37      * @param limits the limits to apply to the search results.
  38      * @return the results.
  39      */
  40     public SearchResults searchForTerm( String principal, List<String> selectedRepos, String term, SearchResultLimits limits );
  41
  42     /**
  43      * Search for a specific term from the previous search results.
  44      *
  45      * @param principal the user doing the search.
  46      * @param selectedRepos the repositories to search from.
  47      * @param term the term to search for.
  48      * @param limits the limits to apply to the search results.
  49      * @param previousSearchTerms the list of the previous search terms.
  50      * @return the results
  51      */
  52     public SearchResults searchForTerm( String principal, List<String> selectedRepos, String term,
  53                                         SearchResultLimits limits, List<String> previousSearchTerms );
  54
  55     /**
  56      * Search for the specific bytecode across all repositories.
  57      *
  58      * @param term the term to search for.
  59      * @param limits the limits to apply to the search results.
  60      * @return the results.
  61      */
  62     public SearchResults searchForBytecode( String principal, List<String> selectedRepos, String term, SearchResultLimits limits );
  63
  64     /**
  65      * Search for the specific checksum string across all repositories.
  66      *
  67      * @param checksum the checksum string to search for.
  68      * @param limits the limits to apply to the search results.
  69      * @return the results.
  70      */
  71     public SearchResults searchForChecksum( String principal, List<String> selectedRepos, String checksum, SearchResultLimits limits );
  72 }