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

   1 package org.apache.archiva.indexer;
   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.repository.Repository;
  23 import org.apache.archiva.repository.RepositoryType;
  24
  25 import java.net.URI;
  26 import java.util.Collection;
  27
  28 public interface ArchivaIndexManager {
  29
  30     /**
  31      * Compresses the index to a more dense packed format.
  32      * @param context
  33      */
  34     void pack(ArchivaIndexingContext context) throws IndexUpdateFailedException;
  35
  36     /**
  37      * Rescans the whole repository, this index is associated to.
  38      * @param context
  39      *
  40      */
  41     void scan(ArchivaIndexingContext context) throws IndexUpdateFailedException;
  42
  43     /**
  44      * Updates the index from the remote url.
  45      * @param context
  46      * @param remoteUpdateUri
  47      * @param fullUpdate
  48      */
  49     void update(ArchivaIndexingContext context, URI remoteUpdateUri, boolean fullUpdate) throws IndexUpdateFailedException;
  50
  51     /**
  52      * Adds a list of artifacts to the index.
  53      * @param context
  54      * @param artifactReference
  55      */
  56     void addArtifactsToIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) throws IndexUpdateFailedException;
  57
  58     /**
  59      * Removes a list of artifacts from the index.
  60      * @param context
  61      * @param artifactReference
  62      */
  63     void removeArtifactsFromIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) throws IndexUpdateFailedException;
  64
  65
  66     /**
  67      * Returns true, if this manager is able to apply the index actions for the given repository type.
  68      * @param type
  69      * @return
  70      */
  71     boolean supportsRepository(RepositoryType type);
  72
  73     /**
  74      * Creates the indexing context for the given repository.
  75      * @param repository the repository for which the index context should be created
  76      * @return the index context
  77      */
  78     ArchivaIndexingContext createContext(Repository repository) throws IndexCreationFailedException;
  79 }