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